@@ -8,8 +8,8 @@ Trait types for NumPy, SciPy and friends
8
8
9
9
Provide a reference implementation of trait types for common data structures
10
10
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
13
13
14
14
which are out of the scope of the main [ traitlets] ( https://github.com/ipython/traitlets )
15
15
project but are a common requirement to build applications with traitlets in
@@ -39,13 +39,13 @@ conda install -c conda-forge traittypes
39
39
40
40
## Usage
41
41
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
49
49
50
50
``` python
51
51
from traitlets import HasTraits, TraitError
0 commit comments