diff options
author | Mark Wiebe <mwiebe@enthought.com> | 2011-06-23 10:28:46 -0500 |
---|---|---|
committer | Mark Wiebe <mwiebe@enthought.com> | 2011-06-23 10:28:46 -0500 |
commit | 8d451bcbdcd5f16342f779b94182d45738a8e8c6 (patch) | |
tree | 3531e3f1c1c7c933cff520c9f4246327cb7edff1 /numpy/add_newdocs.py | |
parent | 2e9e8aada9b5ada7841442dba6b111e446a35849 (diff) | |
parent | ddf8d422571e6fa77d4ede57eb0754f32e25b7ed (diff) | |
download | numpy-8d451bcbdcd5f16342f779b94182d45738a8e8c6.tar.gz |
Merge branch 'struct_cleanup'
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r-- | numpy/add_newdocs.py | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index 58594b15a..760d258f2 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -5563,7 +5563,8 @@ add_newdoc('numpy.core.multiarray', 'dtype', align : bool, optional Add padding to the fields to match what a C compiler would output for a similar C-struct. Can be ``True`` only if `obj` is a dictionary - or a comma-separated string. + or a comma-separated string. If a struct dtype is being created, + this also sets a sticky alignment flag ``isalignedstruct``. copy : bool, optional Make a new copy of the data-type object. If ``False``, the result may just be a reference to a built-in data-type object. @@ -5787,6 +5788,14 @@ add_newdoc('numpy.core.multiarray', 'dtype', ('isnative', """)) +add_newdoc('numpy.core.multiarray', 'dtype', ('isalignedstruct', + """ + Boolean indicating whether the dtype is a struct which maintains + field alignment. This flag is sticky, so when combining multiple + structs together, it is preserved and produces new dtypes which + are also aligned. + """)) + add_newdoc('numpy.core.multiarray', 'dtype', ('itemsize', """ The element size of this data-type object. |