Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Allow for hanging indent when documenting args in Google style #564

Merged
merged 13 commits into from
Dec 30, 2021
Merged

Allow for hanging indent when documenting args in Google style #564

merged 13 commits into from
Dec 30, 2021

Conversation

rmorshea
Copy link
Contributor

@rmorshea rmorshea commented Dec 9, 2021 •
edited
Loading

Closes: #449

Please make sure to check for the following items:

  • Add unit tests and integration tests where applicable.
    If you've added an error code or changed an error code behavior,
    you should probably add or change a test case file under tests/test_cases/ and add
    it to the list under tests/test_definitions.py.
    If you've added or changed a command line option,
    you should probably add or change a test in tests/test_integration.py.
  • Add a line to the release notes (docs/release_notes.rst) under "Current Development Version".
    Make sure to include the PR number after you open and get one.

@rmorshea rmorshea mentioned this pull request Dec 9, 2021
Closed
@rmorshea
Update release_notes.rst
1455277
@rmorshea
remove extraneous print
a1dd075
@rmorshea
Better handling of new line
76ed7b4 
The catches the case there the docstring is

x
    : asdasd

Which, without these changes, would be treated the same as

x:
    asdasd
@rmorshea
No need for multiline mode
aa06e9a
@rmorshea
Copy link
Contributor Author

Tests should pass now.

@rmorshea
Copy link
Contributor Author

rmorshea commented Dec 20, 2021 •
edited
Loading

@SyntaxColoring @sigmavirus24 any chance of a re-review on this?

@rmorshea
Copy link
Contributor Author

rmorshea commented Dec 30, 2021 •
edited
Loading

Looks like the pip install failed on windows. Maybe re-running CI again will just pass?

@sambhav sambhav changed the title allow for hanging indent in google style Args docs Allow for hanging indent when documenting args in Google style Dec 30, 2021
@sambhav sambhav merged commit 1011866 into PyCQA:master Dec 30, 2021
@rmorshea
Copy link
Contributor Author

rmorshea commented Dec 30, 2021 •
edited
Loading

Thanks @samj1912!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@SyntaxColoring SyntaxColoring SyntaxColoring left review comments

@sambhav sambhav sambhav approved these changes

@sigmavirus24 sigmavirus24 Awaiting requested review from sigmavirus24

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

D417 - Add hanging indent support for Google style
4 participants
@rmorshea @sigmavirus24 @SyntaxColoring @sambhav