Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace all parameter references from double backticks to single #5716

Merged
merged 4 commits into from
Nov 25, 2024

Conversation

klecki
Copy link
Contributor

@klecki klecki commented Nov 19, 2024

Category: Other

Description:

Semi-automatically search for all parameters wrapped in double backticks and replace them with single backticks so that the sphinx automation can recognize them and inject the :paramref: directive allowing for proper linking to parameters via their references.

Additional information:

Affected modules and functionalities:

Docstring, some deprecation mechanism.

There might be too much changes applied (some strings were used in the errors/warnings), so review of the changes and running the tests is necessary to revert some of the changes.

I see few glitches, will fix them tomorrow.

Key points relevant for the review:

Please click on the links and check if they work :)

Tests:

  • Existing tests apply
  • New tests added
    • Python tests
    • GTests
    • Benchmark
    • Other
  • N/A

Checklist

Documentation

  • Existing documentation applies
  • Documentation updated
    • Docstring
    • Doxygen
    • RST
    • Jupyter
    • Other
  • N/A

DALI team only

Requirements

  • Implements new requirements
  • Affects existing requirements
  • N/A

REQ IDs: N/A

JIRA TASK: N/A

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
@klecki
Copy link
Contributor Author

klecki commented Nov 19, 2024

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [20578019]: BUILD STARTED

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
@klecki
Copy link
Contributor Author

klecki commented Nov 19, 2024

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [20578956]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [20578956]: BUILD FAILED

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
@klecki
Copy link
Contributor Author

klecki commented Nov 25, 2024

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [20777008]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [20777008]: BUILD PASSED

@klecki klecki merged commit c4f280c into NVIDIA:main Nov 25, 2024
7 checks passed
@klecki klecki deleted the single-ticks branch November 25, 2024 15:36
@klecki klecki added the Sphinx label Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants