DOCS: add links and sections to PR template #18348
Closed
Conversation
This file contains hidden or 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
4f221f7 to
e827dd9
Compare
e827dd9 to
61842d1
Compare
61842d1 to
e01ac9a
Compare
|
@story645 as promised, a separate PR where I take out the "there", and generally clean this up more. Feel free to insert all of your strong opinions here :) |
|
um the changed file is |
timhoffm
reviewed
Aug 26, 2020
| @@ -358,9 +358,20 @@ blocks in source code that explain how the code works. | |||
| you may see in the source code. Pull requests updating docstrings to | |||
| the current style are very welcome. | |||
|
|
|||
| All new or edited docstrings should conform to the `numpydoc docstring guide`_. | |||
| All new or edited docstrings should conform to the `numpydoc docstring guide`_, | |||
| and to the guide below wherever the numpydoc guide is ambiguous. | |||
There was a problem hiding this comment.
Suggested change
| and to the guide below wherever the numpydoc guide is ambiguous. | |
| with the adaptions and clarifications listed below. |
In some points we're intentionally deviating from numpydoc, e.g. usage of optional.
|
|
||
| .. code-block:: bash | ||
|
|
||
| $ flake8 --docstring-convention=all |
There was a problem hiding this comment.
Why do we have to modify the standards from the .flake8 config file?
| All new or edited docstrings should conform to the `numpydoc docstring guide`_. | ||
| All new or edited docstrings should conform to the `numpydoc docstring guide`_, | ||
| and to the guide below wherever the numpydoc guide is ambiguous. | ||
| To quickly check that new docstrings conform to our style guide, run the |
There was a problem hiding this comment.
Suggested change
| To quickly check that new docstrings conform to our style guide, run the | |
| To check that new docstrings conform to our style guide, run the |
"quickly" - this takes 3min CPU time on my PC.
|
I'm going to close this as too verbose. But feel free to ask for a re-open if you feel strongly the PR template is poor. |
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.
PR Summary
Goes on top of #18341, which has been kept separate since everyone has strong opinions about organization.Here's my proposal for how to reorg the checklist:Here's what the checklist looks like with those changes:
PR Checklist
Code:
pytestpasses).flake8on changed files to check).New features:
doc/users/next_whats_new/(follow instructions in the "What's New" README).API Changes:
doc/api/next_api_changes/(follow instructions in the API changes README).Documentation:
flake8 --docstring-convention=allpasses).