Skip to content

Commit b6edc01

Browse files
committed
update stringdtype readme
1 parent 75c05cd commit b6edc01

File tree

1 file changed

+2
-18
lines changed

1 file changed

+2
-18
lines changed

stringdtype/README.md

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
This is the prototype implementation of the variable-width UTF-8 string DType
44
described in [NEP 55](https://numpy.org/neps/nep-0055-string_dtype.html).
55

6-
See the NEP for implementation details and usage examples. Full
7-
documentation will be written as before this code is merged into NumPy.
6+
See the NEP for implementation details and usage examples. See
7+
`numpy.dtypes.StringDType` for the version that made it into NumPy.
88

99
## Building
1010

@@ -37,19 +37,3 @@ $ meson build
3737
$ python -m build --wheel -Cbuilddir=build
3838
$ python -m pip install dist/path-to-wheel-file.whl
3939
```
40-
41-
## Usage
42-
43-
The dtype will not import unless you run python executable with
44-
the `NUMPY_EXPERIMENTAL_DTYPE_API` environment variable set:
45-
46-
```bash
47-
$ NUMPY_EXPERIMENTAL_DTYPE_API=1 python
48-
Python 3.11.3 (main, May 2 2023, 11:36:22) [GCC 11.3.0] on linux
49-
Type "help", "copyright", "credits" or "license" for more information.
50-
>>> from stringdtype import StringDType
51-
>>> import numpy as np
52-
>>> arr = np.array(["hello", "world"], dtype=StringDType())
53-
>>> arr
54-
array(['hello', 'world'], dtype=StringDType())
55-
```

0 commit comments

Comments
 (0)