Use absolute addressing for parameters #5725
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Injecting full qualified path to parameters solve problems with lookup of enclosing entity and generating valid links for modules that are runtime generated. The missing-reference resolver of sphinx paramlinks assume that `source` of all nodes has format: "/path/to/file.py:docstring of module.clsname.methname" and requires the `:`, while members of generated DALI submodules have only the: "docstring of nvidia.dali.fn.decoders.image" part, so the regex doesn't match. If the reference is fully specified, the plugin doesn't need to look it up and doesn't use the unsuitable regex. Some nvidia.dali.ops module specific code is added, so we try to always obtain the `__call__` signature (it contains all inputs and kwargs) and we try to link to either class or `__call__` documentation depending if we are documenting input or kwarg - as that API has this specific distinction. Other parts of API don't have specific conventions. Signed-off-by: Krzysztof Lecki <[email protected]>
18 tasks
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
!build |
|
CI MESSAGE: [20790935]: BUILD FAILED |
|
!build |
|
CI MESSAGE: [20812894]: BUILD STARTED |
mzient
reviewed
Nov 26, 2024
|
CI MESSAGE: [20812894]: BUILD PASSED |
mzient
approved these changes
Nov 26, 2024
Co-authored-by: Michał Zientkiewicz <[email protected]>
|
!build |
|
CI MESSAGE: [20821956]: BUILD STARTED |
|
CI MESSAGE: [20821956]: BUILD FAILED |
klecki
commented
Nov 26, 2024
|
!build |
|
CI MESSAGE: [20823153]: BUILD STARTED |
banasraf
approved these changes
Nov 26, 2024
|
CI MESSAGE: [20823153]: BUILD PASSED |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Category: Bug fix, Other
Description:
Injecting full qualified path to parameters solve problems with lookup of enclosing entity and generating valid links for submodules that are runtime generated.
The missing-reference resolver of sphinx paramlinks assume that
sourceof all nodes has format:"/path/to/file.py:docstring of module.clsname.methname" and requires the
:, while members of generated DALI submodules have only the:"docstring of nvidia.dali.fn.decoders.image"
part, so the regex doesn't match. If the reference is fully specified, the plugin doesn't need to look it up and doesn't use the unsuitable regex.
Some nvidia.dali.ops module specific code is added, so we try to always obtain the
__call__signature (it contains all inputs and kwargs) and we try to link to either class or__call__documentation depending if we are documenting input or kwarg - as that API has this specific distinction.Other parts of API don't have specific conventions.
One example in pipeline doc showcases the ability to reference parameters of other functions.
Additional information:
Affected modules and functionalities:
Sphinx doc generation
Key points relevant for the review:
Tests:
Checklist
Documentation
DALI team only
Requirements
REQ IDs: N/A
JIRA TASK: N/A