Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content
This repository was archived by the owner on Jun 10, 2020. It is now read-only.

Commit c49d2d6

Browse files
authored
MAINT: add note that development has moved to NumPy (#88)
1 parent b828ca5 commit c49d2d6

File tree

1 file changed

+1
-23
lines changed

1 file changed

+1
-23
lines changed

README.md

+1-23
Original file line numberDiff line numberDiff line change
@@ -1,23 +1 @@
1-
# numpy-stubs: experimental typing stubs for NumPy
2-
3-
[![Build Status](https://travis-ci.org/numpy/numpy-stubs.svg?branch=master)](https://travis-ci.org/numpy/numpy-stubs)
4-
5-
**We are currently focused on moving these type stubs into the
6-
NumPy main repo. We look forward to your contributions once the
7-
migration is complete!**
8-
9-
This repository exists for developing [PEP 484](https://www.python.org/dev/peps/pep-0484/)
10-
compatible typing annotations for [NumPy](https://github.com/numpy/numpy).
11-
12-
The plan:
13-
14-
1. Write basic type stubs for `numpy.ndarray` without dtypes or shapes.
15-
2. Add support for dtypes in ndarray type-annotations.
16-
- This might be as simple as writing `np.ndarray[np.float64]`, but will need a
17-
decision about appropriate syntax for shape typing to ensure that this is
18-
forwards compatible with typing shapes.
19-
- This will likely require minor changes to NumPy itself, e.g., to add
20-
`ndarray.__class_getitem__` per PEP 560.
21-
3. Add support for shapes in ndarray type-annotations.
22-
- This will first require defining a broader (Python wide) standard for
23-
typing array shapes, and likely entail writing a PEP.
1+
**These stubs have been merged into NumPy, and all further development will happen in the NumPy main repo. We welcome your contributions there!**

0 commit comments

Comments
 (0)