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

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

Merged
merged 3 commits into from
Apr 23, 2016

Conversation

Nurdok
Copy link
Member

@Nurdok 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
Copy link
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
@Nurdok Nurdok deleted the d404-this branch April 23, 2016 19:53
@Nurdok Nurdok restored the d404-this branch May 13, 2016 08:22
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants