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 fe4412b

Browse files
authored
DOC: Update README to mention pending migration to NumPy (#86)
Update the README to reflect the upcoming migration of the stubs into the main NumPy repo. Hopefully this will help clarify the plan for people interested in contributing.
1 parent 5aaa332 commit fe4412b

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

README.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@
22

33
[![Build Status](https://travis-ci.org/numpy/numpy-stubs.svg?branch=master)](https://travis-ci.org/numpy/numpy-stubs)
44

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+
59
This repository exists for developing [PEP 484](https://www.python.org/dev/peps/pep-0484/)
610
compatible typing annotations for [NumPy](https://github.com/numpy/numpy).
711

8-
It will be released as a separate "numpy-stubs" package on PyPI per [PEP
9-
561](https://www.python.org/dev/peps/pep-0561/). This will let us iterate
10-
rapidly on experimental type annotations without coupling to NumPy's release
11-
cycle.
12-
13-
The plan (help wanted!):
12+
The plan:
1413

1514
1. Write basic type stubs for `numpy.ndarray` without dtypes or shapes.
1615
2. Add support for dtypes in ndarray type-annotations.
@@ -22,6 +21,3 @@ The plan (help wanted!):
2221
3. Add support for shapes in ndarray type-annotations.
2322
- This will first require defining a broader (Python wide) standard for
2423
typing array shapes, and likely entail writing a PEP.
25-
26-
Eventually, once development has stabilized, we expect to merge these type stubs
27-
into the main NumPy repository.

0 commit comments

Comments
 (0)