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

Mark missing docstrings for nested classes as violation D106 #261

Merged
merged 1 commit into from Jun 7, 2017

Conversation

Projects
None yet
2 participants
@rhoog
Copy link
Contributor

rhoog commented May 30, 2017

Currently D101 covers both classes and nested classes. This is a problem if you want to exclude e.g. a Meta nested class from needing a docstring.
In this pull request I put Nested Classes that miss a docstring under D106. This allows me to configure pydocstyle to check for D101, but exclude the D106 situation.

This problem is also discussed at: #198

@Nurdok
Copy link
Member

Nurdok left a comment

Looks good. Can you please just add an entry to the release notes in the docs?

@rhoog rhoog force-pushed the rhoog:master branch from 6326b96 to d7cf243 May 31, 2017

@rhoog

This comment has been minimized.

Copy link
Contributor

rhoog commented May 31, 2017

@Nurdok Sure. I've assumed v2.0.1 is up next and put it under this version in the release docs.

@Nurdok Nurdok merged commit d7cf243 into PyCQA:master Jun 7, 2017

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@Nurdok

This comment has been minimized.

Copy link
Member

Nurdok commented Jun 7, 2017

Merged via #263. Thanks, @rhoog!

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