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

Fix trailing newlines in operator arguments docs #3841

Merged
merged 1 commit into from
Apr 25, 2022

Conversation

stiepan
Copy link
Member

@stiepan stiepan commented Apr 22, 2022

Signed-off-by: Kamil Tokarski ktokarski@nvidia.com

Category:

Other (e.g. Documentation, Tests, Configuration)

Description:

Fixes an issue with operators named arguments documentation. If the argument's C++ docstring ends in a new line, the Python code that generates documentation may end up adding too much new lines separating the docstring and auto-generated remarks to the argument, which in effect leads to incorrect parsing of the whole docstring by Sphinx. See the example below:
Supports per-frame inputs is appended by Python docs generator to both angle and axis arguments, but the second one has trailing newlines in C++ definition, which leads to incorrectly parsed docs as in the second picture.

With the PR:
fixed

Without the PR:
overindented

Additional information:

Affected modules and functionalities:

It's a one liner in Python docs generating script.

Key points relevant for the review:

Checklist

Tests

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

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: DALI-2751

Signed-off-by: Kamil Tokarski <ktokarski@nvidia.com>
@stiepan stiepan marked this pull request as ready for review April 25, 2022 09:14
@awolant awolant self-assigned this Apr 25, 2022
@stiepan
Copy link
Member Author

stiepan commented Apr 25, 2022

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [4668868]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [4668868]: BUILD PASSED

@stiepan stiepan merged commit db7b6d5 into NVIDIA:main Apr 25, 2022
cyyever pushed a commit to cyyever/DALI that referenced this pull request May 13, 2022
…ator docs (NVIDIA#3841)

Signed-off-by: Kamil Tokarski <ktokarski@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jun 7, 2022
…ator docs (NVIDIA#3841)

Signed-off-by: Kamil Tokarski <ktokarski@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants