From 18594cd9653a865fddfa4cd81f82ab54430be1c9 Mon Sep 17 00:00:00 2001 From: Pauli Virtanen Date: Tue, 28 Oct 2008 00:13:44 +0000 Subject: Import documentation from doc wiki (part 2, work-in-progress docstrings, but they are still an improvement) --- numpy/core/defchararray.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'numpy/core/defchararray.py') 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 -- cgit v1.2.1