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

Update information on pep257 & numpy conventions #300

Merged
merged 4 commits into from Apr 7, 2018

Conversation

@namurphy
Copy link
Contributor

namurphy commented Feb 21, 2018

The file error_codes.rst had information that specified the pep257 default convention, but lacked information about the numpy convention. I updated this section of the docs with the conventions specified at the end of src/pydocstyle/violations.py, which presently are:

conventions = AttrDict({
    'pep257': all_errors - {'D203', 'D212', 'D213', 'D214', 'D215', 'D404',
                            'D405', 'D406', 'D407', 'D408', 'D409', 'D410',
                            'D411'},
    'numpy': all_errors - {'D107', 'D203', 'D212', 'D213', 'D402', 'D413'}
})
namurphy added 2 commits Feb 21, 2018
The file `error_codes.rst` had information that specified the pep257
default convention, but lacked information about the numpy convention.
I updated this section of the docs with the conventions specified at
the end of `src/pydocstyle/violations.py`, which presently are:

conventions = AttrDict({
    'pep257': all_errors - {'D203', 'D212', 'D213', 'D214', 'D215', 'D404',
                            'D405', 'D406', 'D407', 'D408', 'D409', 'D410',
                            'D411'},
    'numpy': all_errors - {'D107', 'D203', 'D212', 'D213', 'D402', 'D413'}
})
Copy link
Member

Nurdok left a comment

Thanks for the PR! I added some minor comments.

@@ -11,6 +11,7 @@ New features

* Violations are now reported on the line where the docstring starts, not the
line of the ``def``/``class`` it corresponds to (#238, #83).
* Updated description of pep257 and numpy conventions.

This comment has been minimized.

Copy link
@Nurdok

Nurdok Feb 22, 2018

Member

Can you please add the PR number here?


These conventions may be specified using `--convention=<name>` when

This comment has been minimized.

Copy link
@Nurdok

Nurdok Feb 22, 2018

Member

Maybe also add an internal link to the command line interface section?

This comment has been minimized.

Copy link
@namurphy

namurphy Mar 24, 2018

Author Contributor

I had added See the :ref:`cli_usage` section for more details., though GitHub didn't show it addressing this since it was in the following lines. Is this the final change that you needed?

@namurphy

This comment has been minimized.

Copy link
Contributor Author

namurphy commented Feb 22, 2018

@Nurdok - Thanks for the review! I just implemented your suggestions.

Copy link
Member

Nurdok left a comment

Sorry for taking so long. One little comment and this can be merged.

@Nurdok
Nurdok approved these changes Apr 7, 2018
@Nurdok Nurdok merged commit 6cca224 into PyCQA:master Apr 7, 2018
2 checks passed
2 checks passed
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@Nurdok

This comment has been minimized.

Copy link
Member

Nurdok commented Apr 7, 2018

Merged! Thank you so much and again, sorry for the long wait.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.