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

DOC: Update README to mention pending migration to NumPy #86

Merged
merged 1 commit into from
Jun 5, 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
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@

[![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).

It will be released as a separate "numpy-stubs" package on PyPI per [PEP
561](https://www.python.org/dev/peps/pep-0561/). This will let us iterate
rapidly on experimental type annotations without coupling to NumPy's release
cycle.

The plan (help wanted!):
The plan:

1. Write basic type stubs for `numpy.ndarray` without dtypes or shapes.
2. Add support for dtypes in ndarray type-annotations.
Expand All @@ -22,6 +21,3 @@ The plan (help wanted!):
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.

Eventually, once development has stabilized, we expect to merge these type stubs
into the main NumPy repository.