diff options
| author | Ashley Whetter <asw@dneg.com> | 2018-05-04 11:18:20 -0700 |
|---|---|---|
| committer | Ashley Whetter <ashley@awhetter.co.uk> | 2018-05-09 22:05:56 -0700 |
| commit | 5915041a113508a0f72232a8234b4a55808f6dd4 (patch) | |
| tree | 6b002b7cb672549834e65cbbc353cf223fe98265 /doc | |
| parent | 2df42c20e804004cd3106c895ce77e5f9b3fbec6 (diff) | |
| download | pylint-git-5915041a113508a0f72232a8234b4a55808f6dd4.tar.gz | |
Relaxed docstring checks for abstract methods
Abstract methods are allowed to document returns documentation even
if the default implementation does not return something.
This is so that an abstract method can document what an implementation
should return.
Abstract methods also do not need to document that they raise a
NotImplementedError. This is because a docstring author may choose to
indicate that the method is abstract in the docstring description,
which is something that we cannot detect.
Closes #2044
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/whatsnew/1.9.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/whatsnew/1.9.rst b/doc/whatsnew/1.9.rst index 67482404f..f9e60111f 100644 --- a/doc/whatsnew/1.9.rst +++ b/doc/whatsnew/1.9.rst @@ -65,3 +65,7 @@ Other Changes and are considered part of the public API. They are still not counted towards the number of methods for `too-many-methods`. + +* docparams allows abstract methods to document returns documentation even + if the default implementation does not return something. + They also no longer need to document raising a NotImplementedError. |