diff options
author | Pauli Virtanen <pav@iki.fi> | 2008-10-28 00:13:44 +0000 |
---|---|---|
committer | Pauli Virtanen <pav@iki.fi> | 2008-10-28 00:13:44 +0000 |
commit | 18594cd9653a865fddfa4cd81f82ab54430be1c9 (patch) | |
tree | 04db708f8a8a3575d129390342ff789ef6f1e170 /numpy/core/defchararray.py | |
parent | 7a70f54f515bb8c586c3967d62731a49217eef95 (diff) | |
download | numpy-18594cd9653a865fddfa4cd81f82ab54430be1c9.tar.gz |
Import documentation from doc wiki (part 2, work-in-progress docstrings, but they are still an improvement)
Diffstat (limited to 'numpy/core/defchararray.py')
-rw-r--r-- | numpy/core/defchararray.py | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/numpy/core/defchararray.py b/numpy/core/defchararray.py index 33e90c965..2dec5634e 100644 --- a/numpy/core/defchararray.py +++ b/numpy/core/defchararray.py @@ -16,6 +16,20 @@ _unicode = unicode # comparisons class chararray(ndarray): + """ + chararray(shape, itemsize=1, unicode=False, buffer=None, offset=0, + strides=None, order=None) + + A character array of string or unicode type. + + The array items will be `itemsize` characters long. + + Create the array using buffer (with offset and strides) if it is + not None. If buffer is None, then construct a new array with strides + in Fortran order if len(shape) >=2 and order is 'Fortran' (otherwise + the strides will be in 'C' order). + + """ def __new__(subtype, shape, itemsize=1, unicode=False, buffer=None, offset=0, strides=None, order='C'): global _globalvar |