summaryrefslogtreecommitdiff
path: root/numpy/doc
Commit message (Collapse)AuthorAgeFilesLines
* DOC, BUG: Fix Python 3.6 invalid escape sequence.Charles Harris2017-08-131-2/+2
| | | | | | | | | The rst markup in numpy/doc/basics.py uses `\s`, which is interpreted by python 3.6 as a deprecated escape sequence. Fix by escaping the `\`. Closes #9551. [ci skip]
* Merge branch 'master' into fix-note-on-quad-precCharles Harris2017-08-121-2/+2
|\
| * Merge pull request #9422 from deniederhut/doc/types-formattingCharles Harris2017-08-121-2/+2
| |\ | | | | | | DOC: correct formatting of basic.types.html
| | * DOC: reverts some escapes [ci-skip]Dillon Niederhut2017-08-111-2/+2
| | |
| | * DOC: removes extraneous whitespace with escapesDillon Niederhut2017-07-271-3/+3
| | | | | | | | | | | | [ci-skip]
| | * DOC: correct formatting of basic.types.htmlDillon Niederhut2017-07-261-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | In the documentation for types allowed in numpy, missing spaces around the backticks for fixed-width formatting cause code examples to appear as plain text, or are causing plain text to appear as code. This commit fixes back tick spacing in the 'Extended Precision' section of the 'Data Types' page.
* | | DOC: Adding backslash between double-backtick and s.Danny Hermes2017-08-111-1/+1
|/ /
* | MAINT: Stop using the undocumented coercion-then-downcast feature of subdtypeEric Wieser2017-08-051-2/+2
| |
* | MAINT/DOC: Use builtin when np.{x} is builtins.{x}.Eric Wieser2017-08-051-1/+1
|/ | | | | | | This is the case for x in {int, bool, str, float, complex, object}. Using the np.{x} version is deceptive as it suggests that there is a difference. This change doesn't affect any external behaviour. The `long` type is missing in python 3, so np.long is still useful
* DOC: BLD: fix lots of Sphinx warnings/errors.Ralf Gommers2017-06-103-39/+40
|
* MAINT: Don't internally use the one-argument whereEric Wieser2017-06-032-2/+3
| | | | nonzero is a clearer spelling
* DOC: update documentation allowing tuple of one in reduce, etc.Marten van Kerkwijk2017-05-171-0/+2
|
* BUG: Support nout == 0 and at methodEric Wieser2017-04-271-1/+4
|
* DOC,TST: clarify example of ndarray subclass using __array_ufunc__Marten van Kerkwijk2017-04-271-7/+6
| | | | Also add a few more tests of the same example for good measure.
* DOC: implement many smaller and bigger changes suggested in review.Marten van Kerkwijk2017-04-271-15/+18
|
* DOC: clarify use of super and getattrMarten van Kerkwijk2017-04-271-11/+36
|
* DOC: Describe __array_func__ in subclassingMarten van Kerkwijk2017-04-271-33/+148
| | | | | This includes the use of super everywhere, and in the brief description of __array_ufunc__ in the reference section.
* DOC: describe current implementation of __array_ufunc__.Marten van Kerkwijk2017-04-271-0/+4
|
* DOC: Removed broken linkJesse Thoren2017-02-231-6/+0
| | | | | Removed a broken link from the subclassing ndarray in the user guide. Removed credit to Pierre Gerard-Marchant, as this is out of place in the user guide. #8673
* DOC: fix typo in 'Indexing Multi-dimensional arrays'Kirill Balunov2017-02-071-2/+2
| | | | [ci skip]
* DOC: change Numpy to NumPy in dosctrings and commentsPierre de Buyl2016-09-069-26/+26
| | | | The strings in error messages were left untouched
* DOC: Update subclassing doc regarding downstream compatgfyoung2016-08-111-0/+47
| | | | [ci skip]
* DOC: Fix more typos in docs and comments.Dongjoon Hyun2016-02-254-6/+6
|
* MAINT: Fix some typos in a code string and commentsDongjoon Hyun2016-01-272-2/+2
|
* Fix number sequenceAbdullah Alrasheed2016-01-141-4/+4
| | | | | | I have found that there are two missing numbers in a sequence in the documentation. http://docs.scipy.org/doc/numpy/user/misc.html#interfacing-to-c It goes 1,2,3,5,7,8 with missing 4 and 6.
* typo corrrected.Daniel2015-12-231-1/+1
|
* DOC: Use print only as function when print_function is imported from __future__gfyoung2015-12-193-22/+22
| | | | Closes gh-6863.
* DOC: remove placeholders and incompleteness warningsPauli Virtanen2015-10-255-50/+0
| | | | | Neither are useful, and will discourage both reading and editing of the material.
* DOC: be more emphatic about Windows and 64 bitsAnne Archibald2015-09-011-7/+9
|
* DOC describe the situation of extended precision in numpyAnne Archibald2015-09-011-0/+37
|
* DOC: Fix docstring warnings in documetation generation.Charles Harris2015-07-011-5/+2
| | | | | | | | | | | | Most of these fixes involve putting blank lines around .. versionadded:: x.x.x and .. deprecated:: x.x.x Some of the examples were also fixed.
* DOC: Update docs.Gabor Kovacs2015-06-211-6/+8
| | | | | | | Update docs for boolean array indexing and nonzero order. Add links to row-major and column-major terms where they appear. Closes #3177
* BUG: automatically convert recarray dtype to np.recordAllan Haldane2015-06-191-27/+13
| | | | | | | | | | | | Viewing an ndarray as a np.recarray now automatically converts the dtype to np.record. This commit also fixes assignment to MaskedArray's dtype attribute, fixes the repr of recarrays with non-structured dtype, and removes recarray.view so that viewing a recarray as a non-structured dtype no longer converts to ndarray type. Fixes #3581
* DOC: Fix typo and some grammarVraj Mohan2015-05-271-2/+2
|
* BUG: recarray __repr__ gives inaccurate representationAllan Haldane2015-01-301-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In https://github.com/numpy/numpy/pull/5483, I solved the problem that a "recarray" and a "record array" (nomenclature defined in https://github.com/numpy/numpy/pull/5482) looked identical by making sure that a type's subclass was listed in the repr. However, recarrays are still represented using the function 'rec.array' even though this function technically creates record arrays, not recarrays. So I have updated recarray.__repr__. Setup: >>> a = np.array([(1,'ABC'), (2, "DEF")], dtype=[('foo', int), ('bar', 'S4')]) >>> recordarr = np.rec.array(a) >>> recarr = a.view(np.recarray) Behavior after https://github.com/numpy/numpy/pull/5483: >>> recordarr rec.array([(1, 'ABC'), (2, 'DEF')], dtype=(numpy.record, [('foo', '<i8'), ('bar', 'S4')])) >>> recarr rec.array([(1, 'ABC'), (2, 'DEF')], dtype=[('foo', '<i8'), ('bar', 'S4')]) New Behavior: >>> recordarr rec.array([(1, 'ABC'), (2, 'DEF')], dtype=[('foo', '<i8'), ('bar', '|S4')]) >>> recarr array([(1, 'ABC'), (2, 'DEF')], dtype=[('foo', '<i8'), ('bar', 'S4')]).view(numpy.recarray)
* BUG: Fix recarray getattr and getindex return typesAllan Haldane2015-01-261-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit makes changes to `__getitem__` and `__getattr__` of recarrays: 1. recarrays no longer convert string ndarrays to chararrays, and instead simply return ndarrays of string type. 2. attribute access and index access of fields now behaves identically 3. dtype.type is now inherited when fields of structured type are accessed Demonstration: >>> rec = np.rec.array([('abc ', (1,1), 1), ('abc', (2,3), 1)], ... dtype=[('foo', 'S4'), ('bar', [('A', int), ('B', int)]), ('baz', int)]) Old Behavior: >>> type(rec.foo), type(rec['foo']) (numpy.core.defchararray.chararray, numpy.recarray) >>> type(rec.bar), type(rec['bar']), rec.bar.dtype.type (numpy.recarray, numpy.recarray, numpy.void) >>> type(rec.baz), type(rec['baz']) (numpy.ndarray, numpy.ndarray) New behavior: >>> type(rec.foo), type(rec['foo']) (numpy.ndarray, numpy.ndarray) >>> type(rec.bar), type(rec['bar']), rec.bar.dtype.type (numpy.recarray, numpy.recarray, numpy.record) >>> type(rec.baz), type(rec['baz']) (numpy.ndarray, numpy.ndarray)
* DOC: improve record/structured array nomenclature & guideAllan Haldane2015-01-223-29/+114
| | | | | | | | | | | This update adds a section better describing record arrays in the user guide (numpy/doc/structured_arrays.py). It also corrects nomenclature, such that "structured array" refers to ndarrays with structured dtype, "record array" refers to modified ndarrays as created by np.rec.array, and "recarray" refers to ndarrays viewed as np.recarray. See the note at the end of the structured array user guide.
* DOC note the effect of #1866 in byteorder discussionJoel Nothman2014-10-221-0/+9
|
* DOC: clean up docs in userguide for interfacing to compiled code a bit.Ralf Gommers2014-04-211-29/+26
| | | | | | Add a link to f2py docs, which was missing. [ci skip]
* Update link to EricsBroadcastingDocRoman Nekhoroshev2014-03-051-1/+1
|
* Merge pull request #4362 from njsmith/masterCharles Harris2014-02-241-2/+2
|\ | | | | [DOC] Fix small inaccuracy in broadcasting docs
| * [DOC] Fix small inaccuracy in broadcasting docsnjsmith2014-02-241-2/+2
| | | | | | During broadcasting, dimensions with size 1 can be matched against 0-sized dimensions, and in this case it's the size 1 dimension that will be shrunk away to nothingness. So it's wrong to say that the *smaller* dimension is the one that changes.
* | ENH: add tobytes and stop using tostring in documentationJulian Taylor2014-02-111-4/+4
|/ | | | | | | tostring returns bytes which are not equal to string, so provide a tobytes function alias. tostring does not emit a deprecation warning yet so rdepends do not need to check two names to support older versions of numpy without warnings.
* DOC: further tweaks to boolean indexing doc to improve clarityGary Oberbrunner2013-12-011-5/+5
|
* DOC: further improvements for boolean array indexing docGary Oberbrunner2013-11-291-7/+14
|
* DOC: Improved doc for boolean array indexingGary Oberbrunner2013-11-201-3/+25
|
* DOC: Add an example of casting array type and byte order using astype.Miguel de Val-Borro2013-11-111-0/+9
|
* STY: Giant whitespace cleanup.Charles Harris2013-08-1816-17/+1
| | | | Now is as good a time as any with open PR's at a low.
* DOC: Fixes for doc/source/user/basics.io.genfromtxt.rst.Jesús Gómez2013-08-011-3/+3
| | | | | Add missing part of usecols negative index explanation and other minor redaction fixes.
* Update structured_arrays.pyhklemm2013-07-281-4/+3
| | | The behaviour documented did not match the actual behaviour of numpy. Explanation changed and the code example updated.