Skip to content

Trim line length in the documentation/examples for the new theme #5479

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jun 4, 2024
Merged

Trim line length in the documentation/examples for the new theme #5479

merged 4 commits into from
Jun 4, 2024

Conversation

JanuszL
Copy link
Contributor

@JanuszL JanuszL commented May 22, 2024 •
edited
Loading

  • the new nvidia-theme recommends the line length of the code snippets
    80 characters, not 100 as used in DALI
  • fixes external source documentation formatting

Category:

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

Description:

  • the new nvidia-theme recommends the line length of the code snippets
    80 characters, not 100 as used in DALI
  • fixes external source documentation formatting

Additional information:

Affected modules and functionalities:

  • documentation in docs directory
  • examples
  • couple of C++ files with the operators docs that include code snippets

Key points relevant for the review:

  • NA

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

@JanuszL JanuszL marked this pull request as draft May 22, 2024 22:32
@review-notebook-app Review Notebook App
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@JanuszL
Copy link
Contributor Author

JanuszL commented May 22, 2024

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15241185]: BUILD STARTED

@JanuszL JanuszL force-pushed the adjust_lenght_docs_2 branch from a4b0ef2 to 52a172f Compare May 22, 2024 22:36
@JanuszL
Copy link
Contributor Author

JanuszL commented May 22, 2024

!build

github-advanced-security[bot]
github-advanced-security bot found potential problems May 22, 2024
View reviewed changes
docs/operations_table.py
Comment on lines +124 to +130
doc_table += formater.format(
"Function",
"Device support",
"Short description",
op_name_max_len=op_name_max_len,
c=" ",
)

Check warning

Code scanning / CodeQL

Unused argument in a formatting call Warning documentation

Too many arguments for string format. Format
"{:{c}<{op_name_max_len}} {:{c}^48} {:{c}<150}"
Loading
requires only 2, but 3 are provided.
docs/operations_table.py
Comment on lines +181 to +183
doc_table += formater.format(
"", "", "", op_name_max_len=op_name_max_len, c="="
)

Check warning

Code scanning / CodeQL

Unused argument in a formatting call Warning documentation

Too many arguments for string format. Format
"{:{c}<{op_name_max_len}} {:{c}^48} {:{c}<150}"
Loading
requires only 2, but 3 are provided.
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15241299]: BUILD STARTED

@JanuszL
Copy link
Contributor Author

JanuszL commented May 22, 2024

!build

@JanuszL JanuszL force-pushed the adjust_lenght_docs_2 branch from 52a172f to 369e9d2 Compare May 22, 2024 22:41
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15241422]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15241422]: BUILD FAILED

@JanuszL JanuszL force-pushed the adjust_lenght_docs_2 branch from 369e9d2 to d904786 Compare May 23, 2024 07:55
@JanuszL
Copy link
Contributor Author

JanuszL commented May 23, 2024

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15252677]: BUILD STARTED

@JanuszL JanuszL closed this May 23, 2024
@JanuszL JanuszL reopened this May 23, 2024
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15252677]: BUILD FAILED

@JanuszL JanuszL force-pushed the adjust_lenght_docs_2 branch from d904786 to 755db18 Compare May 23, 2024 19:40
@JanuszL
Copy link
Contributor Author

JanuszL commented May 23, 2024

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15268625]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15268625]: BUILD FAILED

@JanuszL JanuszL force-pushed the adjust_lenght_docs_2 branch from 755db18 to ea6c251 Compare May 24, 2024 07:57
@JanuszL
Copy link
Contributor Author

JanuszL commented May 24, 2024

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15282670]: BUILD STARTED

@JanuszL JanuszL marked this pull request as ready for review May 24, 2024 09:30
@JanuszL JanuszL force-pushed the adjust_lenght_docs_2 branch from ea6c251 to 32c6138 Compare May 24, 2024 09:30
@JanuszL JanuszL changed the title Trim line lenght in the docuemntation/examples for the new theme Trim line length in the documentation/examples for the new theme Jun 2, 2024
@JanuszL JanuszL force-pushed the adjust_lenght_docs_2 branch from 7004721 to 792ec6d Compare June 3, 2024 10:44
@JanuszL
Copy link
Contributor Author

JanuszL commented Jun 3, 2024

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15525264]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15525264]: BUILD FAILED

@JanuszL JanuszL force-pushed the adjust_lenght_docs_2 branch from 117aa79 to 79f8256 Compare June 3, 2024 13:26
@JanuszL
Copy link
Contributor Author

JanuszL commented Jun 3, 2024

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15528182]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15528182]: BUILD PASSED

@JanuszL JanuszL force-pushed the adjust_lenght_docs_2 branch from 79f8256 to f9186ea Compare June 3, 2024 15:30
@JanuszL
Copy link
Contributor Author

JanuszL commented Jun 3, 2024

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15530558]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15530558]: BUILD PASSED

JanuszL added 4 commits June 4, 2024 15:32
@JanuszL
Adjust files manually
6980487 
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
@JanuszL
Fix external source formating
7e853da 
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
@JanuszL
Reformat documentation automatically
7637a09 
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
@JanuszL
Review fix
74a6e5a 
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
@JanuszL JanuszL force-pushed the adjust_lenght_docs_2 branch from f9186ea to 74a6e5a Compare June 4, 2024 13:45
@JanuszL
Copy link
Contributor Author

JanuszL commented Jun 4, 2024

!build

@mzient mzient assigned mzient and unassigned banasraf Jun 4, 2024
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15559824]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15559824]: BUILD PASSED

@JanuszL JanuszL merged commit ea2eff0 into NVIDIA:main Jun 4, 2024
6 checks passed
@JanuszL JanuszL deleted the adjust_lenght_docs_2 branch June 4, 2024 19:40
JanuszL added a commit to JanuszL/DALI that referenced this pull request Jun 7, 2024
@JanuszL
Exclude docs line length adjustment PR from the blame history
6a592f2 
- excludes NVIDIA#5479

Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
@JanuszL JanuszL mentioned this pull request Jun 7, 2024
Merged
18 tasks
JanuszL added a commit that referenced this pull request Jun 10, 2024
@JanuszL
Exclude docs line length adjustment PR from the blame history (#5509)
d6b29c7 
- excludes #5479

Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jantonguirao jantonguirao jantonguirao approved these changes

@szalpal szalpal szalpal approved these changes

@mzient mzient mzient approved these changes

Assignees

@jantonguirao jantonguirao

@szalpal szalpal

@mzient mzient

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@JanuszL @dali-automaton @szalpal @jantonguirao @mzient @banasraf