summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
Commit message (Collapse)AuthorAgeFilesLines
* MAINT: Move add_newdocs into core, since it only adds docs to those piecesEric Wieser2018-07-021-8144/+0
|
* MAINT: Remove python-side docstrings from add_newdocs.Eric Wieser2018-07-011-88/+0
| | | | | | From the header comment in add_newdocs, it is only intended for C modules. This also fixes `help(np.mgrid)`, which previously only showed the help for `nd_grid`
* Merge pull request #11425 from eric-wieser/where-nonzero-docsMarten van Kerkwijk2018-06-291-38/+39
|\ | | | | DOC: Clear up confusion between np.where(cond) and np.where(cond, x, y)
| * DOC: Clear up confusion between np.where(cond) and np.where(cond, x, y)Eric Wieser2018-06-291-38/+39
| | | | | | | | | | | | | | | | Eliminates all mentions of `np.where(cond)`, instead pointing the reader to np.nonzero. Also changes some example numbers to avoid collisions, making them easier to follow. Some minor doc improvements for np.ma.where too.
* | Merge pull request #11347 from mattip/less-sphinx-warningsRalf Gommers2018-06-271-2/+3
|\ \ | | | | | | DOC: Silence many sphinx warnings
| * | DOC: typos, small fixesmattip2018-06-151-2/+3
| | |
* | | DOC: Update einsum docs (#11234)attack682018-06-271-118/+197
| |/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Einsum docs improvements. * DOC: add information to numpy.core.einsumfunc * DOC: add information to numpy.core.einsumfunc * DOC: add information to numpy.core.einsumfunc * DOC: add information to numpy.core.einsumfunc * DOC: remove 'numpy.core','c_einsum' section from 'add_newdocs.py' * DOC: make :py:func links to all internal functions. * DOC: make :py:func links to all internal functions (minor corrections) * DOC: place `add_newdoc('numpy.core.multiarray','c_einsum'`,...) in file. * DOC: minor requested corrections * DOC: suggested optimize argument Example cases * DOC: copy amendments to second docstring location in add_newdocs.py * DOC: more descriptive text * DOC: required correction to specify a default argument. * DOC: minor presentation fix for example display in einsumfunc.py * DOC: amend c_einsum documentation version, add note about dual documentation
* | HTTP -> HTTPS, and other linkrot fixesMike Toews2018-06-161-1/+1
|/
* TST: Add np.core._multiarray_tests.format_float_OSprintf_gEric Wieser2018-05-281-0/+31
| | | | | For development/testing purposes, it's convenient to have access to the system printf for floats. This is a very simple printf interface.
* DOC: Clarify tofile requirementKevin Sheppard2018-05-221-0/+5
| | | | | Clarify that tofile requires a file that can be directly written to and not a general file-like object
* DOC: Mention we can return unitinitialized values (#11086)Matti Picus2018-05-151-3/+7
| | | | | | | | | | | | * DOC: mention we can return unitinitialized values * squash and rebase, extend explanation and improve docstring template * MAINT: Spelling fixes for docstrings. [ci skip] * MAINT: Update following feedback.
* Merge pull request #10949 from mattip/doc-nditerAllan Haldane2018-04-271-5/+11
|\ | | | | DOC: cleanup documentation, continuation of nditer PR #9998
| * DOC: cleanup documentation, continuation of nditer PR #9998mattip2018-04-231-5/+11
| |
* | ENH: Implement initial kwarg for ufunc.add.reduceHameer Abbasi2018-04-241-2/+27
|/
* emphasis accessing `it.operands` only on open iteratormattip2018-04-221-9/+19
|
* Merge pull request #9998 from mattip/nditer-as-context-managerAllan Haldane2018-04-211-8/+41
|\ | | | | ENH: Nditer as context manager
| * fixes from reviewmattip2018-04-211-3/+4
| |
| * ENH: add nditer.close as per reviewmattip2018-04-201-1/+1
| |
| * ENH: add NpyIter_Close, nditer__{enter,exit}__mattip2018-04-201-8/+40
| |
* | DOC: clear up warnings, fix matplotlib plotmattip2018-04-171-11/+7
|/
* Merge pull request #10867 from Carreau/link-fullStefan van der Walt2018-04-141-7/+17
|\ | | | | DOC: Cross-reference full/full_like in a few "See Also" sections.
| * 'remove indirect relationships'Matthias Bussonnier2018-04-091-9/+0
| |
| * Cross Link full/full_like in a few see-also.Matthias Bussonnier2018-04-091-5/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | While teaching numpy I was asked the best way to create an array of nan, and `np.full` seem not be cross linked from many places; In particular in the documentation of `zeros` and `ones` seam like obvious candidates to add them. Reorder all the see-also to be - empty_like - ones_like - zero_like - full_like - empty - ones - zeros - full
* | DOC: State in docstring that lexsort is stable (#10873).Pierre Chanial2018-04-101-1/+1
|/
* add stablesort in np.sort and point to mergesortLakshay Garg2018-03-231-1/+1
| | | | Closes #10784
* fixed order of notes and examplesJonas Rauber2018-03-151-8/+8
|
* Update add_newdocs.pyJonas Rauber2018-03-151-3/+9
|
* fixes #10747Jonas Rauber2018-03-151-2/+4
|
* DOC zeros, empty, and ones now have consistent docstringsNelle Varoquaux2018-03-011-7/+9
| | | | closes #10611
* Update add_newdocs.pyEric Wieser2018-02-161-1/+1
|
* DOC: promote_types is _not_ associative by design, despite the fact it would ↵Eric Wieser2018-02-081-1/+9
| | | | | | be nice if it was Also give an example of the non-associative case.
* DOC: See #7968derrick2018-01-121-1/+4
|
* DOC: Fix typos in partition method (#10334)Milo2018-01-051-4/+4
|
* Merge pull request #10298 from eric-wieser/digitize-docsCharles Harris2017-12-311-8/+21
|\ | | | | DOC: Explain np.digitize and np.searchsorted more clearly
| * DOC: Explain np.digitize more clearlyEric Wieser2017-12-311-8/+21
| | | | | | | | | | | | | | Show the four modes in a table for clarity Compare to searchsorted [ci-skip]
* | ENH: Allow ptp to take an axis tuple and keepdimsEric Wieser2017-12-281-1/+1
|/
* DOC: document nested_iters (#10078)Matti Picus2017-12-151-0/+61
|
* DOC: change 'a'->'prototype' in empty_like docsJake VanderPlas2017-12-121-8/+8
|
* DOC: Add documentation for datetime_dataEric Wieser2017-11-271-0/+37
| | | | [ci-skip]
* DOC: Add documentation for datetime_as_stringEric Wieser2017-11-271-0/+61
| | | | [ci-skip]
* DOC: add docstring to ufunc.signatureMarten van Kerkwijk2017-11-251-5/+35
|
* Merge pull request #9458 from eric-wieser/copyto-scalarAllan Haldane2017-11-201-1/+1
|\ | | | | MAINT: Improve performance of np.copyto(where=scalar)
| * DOC: Fix incorrect default for whereEric Wieser2017-07-241-1/+1
| | | | | | | | None would be cast to False, which is the opposite of the intended default!
* | ENH: don't show boolean dtype, as it is impliedEric Wieser2017-11-131-1/+1
| |
* | DEP, ENH: deprecate UPDATEIFCOPY (except for nditer) and replace with ↵Matti Picus2017-11-081-18/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | WRITEBACKIFCOPY (#9639) * ENH: add API to resolve UPDATEONCOPY outside dealloc, test and use * BUG: Fix usage of keyword "from" as argument name for "can_cast". Also removed inconsistency between the second argument name between documentation ("totype") and code ("to"). * UPDATEIFCOPY -> WRITEBACKIFCOPY, documentation * fixes for review * review2, fix new test * fix new test for using self.assert_deprecated * change deprecation logic as per review * new logic exposed places where PyArray_ResolveWritebackIfCopy not called * deprecate PyArray_XDECREF_ERR in favor of PyArray_DiscardWritebackIfCopy * code review changes * clean up merge cruft * fix from review * fixes from review * extend the release note
* | Merge pull request #9920 from xuhdev/dot-docCharles Harris2017-11-071-5/+15
|\ \ | | | | | | DOC: dot: Add explanation in case `b` has only 1 dimension.
| * | DOC: dot: Improve and add explanation in case `b` has only 1 dimension.Hong Xu2017-11-051-5/+15
| | |
* | | DOC: ndarray.reshape allows shape as int arguments or tupleJohn Goetz2017-10-251-0/+7
|/ / | | | | | | | | Adding note about difference between `numpy.reshape` and `ndarray.reshape`. See issue #570
* | MAINT: Punctuate `fromstring` docstring.Charles Harris2017-10-221-2/+2
| | | | | | [ci skip]
* | DEP: Letting fromstring pretend to be frombuffer is a bad ideaEric Wieser2017-10-191-10/+13
| | | | | | | | Interpreting a unicode string as raw binary data is a terrible idea, especially if the encoding is determined by the system (python 2)
View Lorry Controller Status