Skip to content

Commit c4223f2

Browse files
Merge pull request #13 from SylvainCorlay/update-readme
Improve README
2 parents bcde46a + a34f27e commit c4223f2

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Trait types for NumPy, SciPy and friends
88

99
Provide a reference implementation of trait types for common data structures
1010
used in the scipy stack such as
11-
- numpy arrays
12-
- pandas / xray data structures
11+
- [numpy](https://github.com/numpy/numpy) arrays
12+
- [pandas](https://github.com/pydata/pandas) and [xarray](https://github.com/pydata/xarray) data structures
1313

1414
which are out of the scope of the main [traitlets](https://github.com/ipython/traitlets)
1515
project but are a common requirement to build applications with traitlets in
@@ -39,13 +39,13 @@ conda install -c conda-forge traittypes
3939

4040
## Usage
4141

42-
The `Array` trait type provide an implementation of a trait type for the numpy
43-
array.
44-
- `Array` overrides some methods from `TraiType` that are generally not
45-
overloaded in order to work around some limitations with numpy array
46-
comparison.
47-
- `Array` provides an API for adding custom validators to constained proposed
48-
values for the attribute.
42+
`traittypes` extends the `traitlets` library with an implementation of trait types for numpy arrays, pandas dataframes and pandas series.
43+
- `traittypes` works around some limitations with numpy array comparison to only trigger change events when necessary.
44+
- `traittypes` also extends the traitlets API for adding custom validators to constained proposed values for the attribute.
45+
46+
For a general introduction to `traitlets`, check out the [traitlets documentation](https://traitlets.readthedocs.io/en/stable/).
47+
48+
### Example usage with a custom validator
4949

5050
```python
5151
from traitlets import HasTraits, TraitError

0 commit comments

Comments
 (0)