diff options
author | Bas van Beek <b.f.van.beek@vu.nl> | 2021-02-04 16:10:30 +0100 |
---|---|---|
committer | Bas van Beek <b.f.van.beek@vu.nl> | 2021-02-05 17:55:25 +0100 |
commit | 53496cdf82d6c9a3ddb40c12746d3257d9e09396 (patch) | |
tree | e005c528406969c6039befb3482bd28cca0d6ef6 /doc | |
parent | cff4ec0d7c4140a1906716dcb536f6a62e4eec69 (diff) | |
download | numpy-53496cdf82d6c9a3ddb40c12746d3257d9e09396.tar.gz |
REL: Add a release note for the mypy plugin update
Diffstat (limited to 'doc')
-rw-r--r-- | doc/release/upcoming_changes/18322.new_feature.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/release/upcoming_changes/18322.new_feature.rst b/doc/release/upcoming_changes/18322.new_feature.rst new file mode 100644 index 000000000..5330b9a97 --- /dev/null +++ b/doc/release/upcoming_changes/18322.new_feature.rst @@ -0,0 +1,22 @@ +Let the mypy plugin manage extended-precision `numpy.number` subclasses +----------------------------------------------------------------------- + +The mypy_ plugin, introduced in `numpy/numpy#17843`_, has been expanded: +the plugin now removes annotations for platform-specific extended-precision +types that are not available to the platform in question. +For example, it will remove `~numpy.float128` when not available. + +Without the plugin *all* extended-precision types will, as far as mypy is concerned, +be available on all platforms. + +To enable the plugin, one must add it to their mypy `configuration file`_: + +.. code-block:: ini + + [mypy] + plugins = numpy.typing.mypy_plugin + + +.. _mypy: http://mypy-lang.org/ +.. _configuration file: https://mypy.readthedocs.io/en/stable/config_file.html +.. _`numpy/numpy#17843`: https://github.com/numpy/numpy/pull/17843 |