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 STRING_VEC default arguments presentation in docs #3470

Merged
merged 2 commits into from
Nov 4, 2021

Conversation

klecki
Copy link
Contributor

@klecki klecki commented Nov 4, 2021

Required for #3459

Description

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactoring (Redesign of existing code that doesn't affect functionality)
  • Other (e.g. Documentation, Tests, Configuration)

What happened in this PR

Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Additional information

  • Affected modules and functionalities:
    Docs

  • 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: N/A

Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

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

klecki commented Nov 4, 2021

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [3332691]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [3332691]: BUILD FAILED

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

klecki commented Nov 4, 2021

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [3332733]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [3332733]: BUILD PASSED

@klecki klecki merged commit cd932e7 into NVIDIA:main Nov 4, 2021
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jan 23, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jan 23, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jan 23, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jan 23, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jan 23, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jan 23, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jan 23, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jan 23, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jan 23, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jan 23, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jan 23, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jan 23, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jan 23, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Feb 21, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request May 13, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
cyyever pushed a commit to cyyever/DALI that referenced this pull request Jun 7, 2022
Adjust python_repr to handle vectors of elements,
as it was currently dead code. We need to call repr
on all strings as we do for single string argument.

Add backticks around the default value in the generated
docstring - it prevents string from interpreting
glob expressions as markdown.

Signed-off-by: Krzysztof Lecki <klecki@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.

4 participants