summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorClaudiu Popa <pcmanticore@gmail.com>2019-05-23 08:20:42 +0200
committerClaudiu Popa <pcmanticore@gmail.com>2019-05-23 08:20:42 +0200
commitb657df6644740e77fa167d4f95c76c4c007d2a49 (patch)
tree820f682ee3e673fa9502518ea96afc7c7a30c982
parentf90b223a5ea70a0b9a52034280fe22638e6ef14d (diff)
downloadpylint-git-b657df6644740e77fa167d4f95c76c4c007d2a49.tar.gz
Mention the name of the new signature-mutators option
-rw-r--r--ChangeLog9
-rw-r--r--doc/whatsnew/2.4.rst9
2 files changed, 12 insertions, 6 deletions
diff --git a/ChangeLog b/ChangeLog
index f8b931a06..c72c43999 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -125,10 +125,13 @@ Release date: TBA
Close #2877
-* Can choose to ignore `too-many-function-args`, `unexpected-keyword-arg`,
- and `no-value-for-parameter` for functions decorated with certain decorators.
+* ``signature-mutators`` option was added
- Close #259
+ With this option, users can choose to ignore `too-many-function-args`, `unexpected-keyword-arg`,
+ and `no-value-for-parameter` for functions decorated with decorators that change
+ the signature of a decorated function.
+
+ Close #259
* Fixed a pragma comment on its own physical line being ignored when part
of a logical line with the previous physical line.
diff --git a/doc/whatsnew/2.4.rst b/doc/whatsnew/2.4.rst
index fa9cc5d3b..1a1ea41da 100644
--- a/doc/whatsnew/2.4.rst
+++ b/doc/whatsnew/2.4.rst
@@ -117,11 +117,14 @@ The following does not trigger a ``missing-return-doc`` anymore ::
"""
return ["hi", "bye"] #@
-* Can choose to ignore `too-many-function-args`, `unexpected-keyword-arg`,
- and `no-value-for-parameter` for functions decorated with certain decorators.
+* ``signature-mutators`` CLI and config option was added.
+
+With this option, users can choose to ignore `too-many-function-args`, `unexpected-keyword-arg`,
+and `no-value-for-parameter` for functions decorated with decorators that change
+the signature of a decorated function.
For example a test may want to make use of hypothesis.
-Adding `hypothesis.extra.numpy.arrays` to `function_mutators`
+Adding `hypothesis.extra.numpy.arrays` to `signature_mutators`
would mean that `no-value-for-parameter` would not be raised for::
@given(img=arrays(dtype=np.float32, shape=(3, 3, 3, 3)))