docs: fix formatting of docstring with lists #1687
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
parthea
changed the title
product-auto-label
bot
added
size: m
parthea
force-pushed
the
ensure-new-line-lists
branch
from
2a956d7 to
75fb83b
Compare
dizcology
approved these changes
Jul 7, 2023
| @@ -115,7 +123,9 @@ def wrap(text: str, width: int, *, offset: Optional[int] = None, indent: int = 0 | |||
| text='\n'.join([textwrap.fill( | |||
| break_long_words=False, | |||
| initial_indent=' ' * indent, | |||
| subsequent_indent=' ' * indent, | |||
| # ensure that subsequent lines for lists are indented 2 spaces | |||
| subsequent_indent=' ' * indent + \ | |||
There was a problem hiding this comment.
Maybe add spaces around =.
There was a problem hiding this comment.
I tried making this change but the style check failed
(py39) partheniou@partheniou-vm-3:~/git/gapic-generator-python$ find gapic tests -name "*.py" -not -path 'tests/**/goldens/*' | xargs autopep8 --diff --exit-code
--- original/gapic/utils/lines.py
+++ fixed/gapic/utils/lines.py
@@ -124,7 +124,7 @@
break_long_words=False,
initial_indent=' ' * indent,
# ensure that subsequent lines for lists are indented 2 spaces
- subsequent_indent = ' ' * indent + \
+ subsequent_indent=' ' * indent + \
(' ' if token.strip().startswith('-') else ''),
text=token,
width=width,
There was a problem hiding this comment.
I wonder if enclosing the right side in parentheses, or breaking this down into if-else statements would work.
dizcology
reviewed
Jul 7, 2023
| # as the new line is required for lists. | ||
| if '\n' in text: | ||
| initial_text = text.split('\n')[0] | ||
| if ":" not in initial_text: |
There was a problem hiding this comment.
Could : appear on text line 2, and the list starts from line 3 and on?
There was a problem hiding this comment.
yes, I added a test case in e08978a
dizcology
approved these changes
Jul 7, 2023
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.
Fixes #1345 🦕
The PR applies the following fixes for the function that converts documentation to RST format.
All of the changes have corresponding tests to show the behaviour without the fixes.