diff options
Diffstat (limited to 'numpy/typing/__init__.py')
| -rw-r--r-- | numpy/typing/__init__.py | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/numpy/typing/__init__.py b/numpy/typing/__init__.py index 04d34f0c7..252123a19 100644 --- a/numpy/typing/__init__.py +++ b/numpy/typing/__init__.py @@ -23,15 +23,18 @@ Mypy plugin ----------- A mypy_ plugin is distributed in `numpy.typing` for managing a number of -platform-specific annotations. Its function can be split into to parts: +platform-specific annotations. Its functionality can be split into three +distinct parts: * Assigning the (platform-dependent) precisions of certain `~numpy.number` subclasses, including the likes of `~numpy.int_`, `~numpy.intp` and `~numpy.longlong`. See the documentation on :ref:`scalar types <arrays.scalars.built-in>` for a - comprehensive overview of the affected classes. without the plugin the precision - of all relevant classes will be inferred as `~typing.Any`. + comprehensive overview of the affected classes. Without the plugin the + precision of all relevant classes will be inferred as `~typing.Any`. +* Assigning the (platform-dependent) precision of `~numpy.ctypeslib.c_intp`. + Without the plugin aforementioned type will default to `ctypes.c_int64`. * Removing all extended-precision `~numpy.number` subclasses that are unavailable - for the platform in question. Most notable this includes the likes of + for the platform in question. Most notably, this includes the likes of `~numpy.float128` and `~numpy.complex256`. Without the plugin *all* extended-precision types will, as far as mypy is concerned, be available to all platforms. |