Added D404: First word of the docstring should not be `This` #183

Merged
merged 3 commits into from Apr 23, 2016

Projects

None yet

2 participants

@Nurdok
Member
Nurdok commented Apr 23, 2016

This is intended to make docstrings shorter and to the point, as they should not start with "This module contains [..]" or "This class represents [..]".

It is unchecked by default as it is not part of the PEP257 standard.

@Nurdok Nurdok self-assigned this Apr 23, 2016
@Nurdok Nurdok modified the milestone: pydocstyle 1.1.0 Apr 23, 2016
@sigmavirus24
Member

This pull request looks fine to me. The fact that it's off by default is helpful too.

@Nurdok Nurdok merged commit 4975051 into PyCQA:master Apr 23, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@Nurdok Nurdok deleted the Nurdok:d404-this branch Apr 23, 2016
@Nurdok Nurdok restored the Nurdok:d404-this branch May 13, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment