diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2016-01-05 12:56:26 -0700 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2016-01-05 16:17:04 -0700 |
| commit | 40e47e06e741797efef60211c58e30ff82c7191f (patch) | |
| tree | 3f71e7ccdcb2baab41a1839887bbfe117339aadb /numpy/add_newdocs.py | |
| parent | 346c700ab16da1deaf95e9f0331ffd76fb2162fa (diff) | |
| download | numpy-40e47e06e741797efef60211c58e30ff82c7191f.tar.gz | |
DOC,BUG: Fix some latex generation problems.
Some of the documentation for newbyteorder, copy and pasted in several
spots, had paragraphs ending in `::`, initiating a sphinx generated
Verbatim environment and resulting in "LaTeX Error: Too deeply nested".
The user_array.container class needed non-empty class documentation.
That that caused a problem is probably a numpydoc bug, but it is easy to
fix.
[skip ci]
Diffstat (limited to 'numpy/add_newdocs.py')
| -rw-r--r-- | numpy/add_newdocs.py | 31 |
1 files changed, 15 insertions, 16 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index 7eef07c4a..e79720c77 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -3888,13 +3888,13 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('newbyteorder', ---------- new_order : string, optional Byte order to force; a value from the byte order specifications - above. `new_order` codes can be any of:: + below. `new_order` codes can be any of: - * 'S' - swap dtype from current to opposite endian - * {'<', 'L'} - little endian - * {'>', 'B'} - big endian - * {'=', 'N'} - native order - * {'|', 'I'} - ignore (no change to byte order) + * 'S' - swap dtype from current to opposite endian + * {'<', 'L'} - little endian + * {'>', 'B'} - big endian + * {'=', 'N'} - native order + * {'|', 'I'} - ignore (no change to byte order) The default value ('S') results in swapping the current byte order. The code does a case-insensitive check on the first @@ -6359,16 +6359,15 @@ add_newdoc('numpy.core.multiarray', 'dtype', ('newbyteorder', Parameters ---------- new_order : string, optional - Byte order to force; a value from the byte order - specifications below. The default value ('S') results in - swapping the current byte order. - `new_order` codes can be any of:: + Byte order to force; a value from the byte order specifications + below. The default value ('S') results in swapping the current + byte order. `new_order` codes can be any of: - * 'S' - swap dtype from current to opposite endian - * {'<', 'L'} - little endian - * {'>', 'B'} - big endian - * {'=', 'N'} - native order - * {'|', 'I'} - ignore (no change to byte order) + * 'S' - swap dtype from current to opposite endian + * {'<', 'L'} - little endian + * {'>', 'B'} - big endian + * {'=', 'N'} - native order + * {'|', 'I'} - ignore (no change to byte order) The code does a case-insensitive check on the first letter of `new_order` for these alternatives. For example, any of '>' @@ -7231,10 +7230,10 @@ add_newdoc('numpy.core.numerictypes', 'generic', ('newbyteorder', The `new_order` code can be any from the following: + * 'S' - swap dtype from current to opposite endian * {'<', 'L'} - little endian * {'>', 'B'} - big endian * {'=', 'N'} - native order - * 'S' - swap dtype from current to opposite endian * {'|', 'I'} - ignore (no change to byte order) Parameters |