Skip to content
This repository has been archived by the owner on Jun 10, 2020. It is now read-only.

MAINT: add note that development has moved to NumPy #88

Merged
merged 1 commit into from
Jun 9, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 1 addition & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1 @@
# numpy-stubs: experimental typing stubs for NumPy

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

**We are currently focused on moving these type stubs into the
NumPy main repo. We look forward to your contributions once the
migration is complete!**

This repository exists for developing [PEP 484](https://www.python.org/dev/peps/pep-0484/)
compatible typing annotations for [NumPy](https://github.com/numpy/numpy).

The plan:

1. Write basic type stubs for `numpy.ndarray` without dtypes or shapes.
2. Add support for dtypes in ndarray type-annotations.
- This might be as simple as writing `np.ndarray[np.float64]`, but will need a
decision about appropriate syntax for shape typing to ensure that this is
forwards compatible with typing shapes.
- This will likely require minor changes to NumPy itself, e.g., to add
`ndarray.__class_getitem__` per PEP 560.
3. Add support for shapes in ndarray type-annotations.
- This will first require defining a broader (Python wide) standard for
typing array shapes, and likely entail writing a PEP.
**These stubs have been merged into NumPy, and all further development will happen in the NumPy main repo. We welcome your contributions there!**