summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* DOC: Tidy up references to str_ / bytes_Eric Wieser2020-10-244-13/+12
| | | | | | | | This: * Fixes some broken references * Cleans up some use of Python 2 aliases: * Switches references to `np.string_` to describe `np.bytes_` instead * Switches references to `np.unicode_` to describe `np.str_` instead
* DOC: Fixup for ``PyUFunc_*``takanori-pskq2020-10-241-1/+3
|
* Update doc/source/reference/random/c-api.rstTakanori H2020-10-241-2/+1
| | | Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* Update doc/source/user/basics.rec.rstTakanori H2020-10-241-1/+1
| | | Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* DOC: Fixup for PR #17614takanori-pskq2020-10-241-1/+1
|
* DOC: Fix some referencestakanori-pskq2020-10-2412-30/+35
|
* DOC: Fix the document for arrays interfacetakanori-pskq2020-10-231-14/+14
|
* Merge pull request #17570 from takanori-pskq/i13114-feature-versionMatti Picus2020-10-221-12/+16
|\ | | | | DOC: Add the entry for ``NPY_FEATURE_VERSION``
| * DOC: Fixuptakanori-pskq2020-10-221-17/+16
| |
| * DOC: Add the entry for ``NPY_FEATURE_VERSION``takanori-pskq2020-10-151-0/+5
| |
* | DOC: Fix typos (general documentation)Alexander Kuhn-Regnier2020-10-212-3/+3
| |
* | DOC: Added a PR "Reviewer guidelines" document. (#17252)Melissa Weber Mendonça2020-10-193-3/+130
| |
* | ENH: add function to get broadcast shape from a given set of shapes. (#17535)madhulikajc2020-10-171-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * ENH: add function to get broadcast shape from a given set of shapes. Add new function numpy.broadcast_shape which takes tuples for the shapes to be broadcast against each other. Return the broadcasted shape as a tuple. See #17217 * Perform array allocations of size 0 for provided shape tuples Co-authored-by: Eric Wieser <wieser.eric@gmail.com> * Test for int as input shape Also update docstring to include both ints and tuples of ints as input * Remove unnecessary array_function_dispatch * Add missing set_module * Add release notes. Add versionadded to docstring. Also fix up docstring details. * follow convention for trailing comma Co-authored-by: Sebastian Berg <sebastian@sipsolutions.net> * Change name to broadcast_shapes. Also add test case, and type hint. * follow convention Co-authored-by: Eric Wieser <wieser.eric@gmail.com> * Update docstring Co-authored-by: Eric Wieser <wieser.eric@gmail.com> * Add reference to numpy docs on broadcasting to docstring Also move versionadded * Fix spelling Co-authored-by: Warren Weckesser <warren.weckesser@gmail.com> * Add broadcast_shapes to reference docs and add See Also sections Co-authored-by: Eric Wieser <wieser.eric@gmail.com> Co-authored-by: Sebastian Berg <sebastian@sipsolutions.net> Co-authored-by: Warren Weckesser <warren.weckesser@gmail.com>
* | DOC: Fix Boolean array indexing typoBen Derrett2020-10-161-1/+1
| |
* | DOC: Fix typostakanori-pskq2020-10-153-4/+4
|/
* Merge pull request #17559 from takanori-pskq/i16217-remove-directivesMatti Picus2020-10-142-16/+6
|\ | | | | DOC: Remove directives for some constants
| * DOC: Remove directives for some constantstakanori-pskq2020-10-142-16/+6
| |
* | Apply suggestions from code reviewEric Wieser2020-10-141-0/+2
| |
* | DOC: Fix wrong blockquotestakanori-pskq2020-10-142-20/+0
|/
* Merge pull request #17523 from bjnath/new-docpage-top-linksCharles Harris2020-10-135-29/+24
|\ | | | | DOC: Update top links in landing page
| * DOC: Explain :orphan: in PR #17523Ben Nathanson2020-10-101-0/+6
| |
| * DOC: Delete unused file in PR #17523Ben Nathanson2020-10-091-10/+0
| | | | | | | | To fix CircleCI fail; missed it in the c6dc9d6 commit.
| * DOC: Update top links in landing pageBen Nathanson2020-10-094-19/+18
| | | | | | | | | | | | Same intent as PR #17365 -- point "Installation" links to Hugo, start page with "What is NumPy", let Hugo page link to "Troubleshooting ImportError".
* | DOC: Add missing types to C function docs (#17549)Takanori H2020-10-134-86/+87
| | | | | | `.. c:function::` expects its contents to be a valid C prototype, meaning the return types and arguments are all need types.
* | DOC: Fix typo (#17534)Takanori H2020-10-111-1/+1
| |
* | DOC: Fix Boolean types in C functionstakanori-pskq2020-10-102-9/+9
| |
* | Merge pull request #17520 from bjnath/show-real-licenseRalf Gommers2020-10-091-32/+3
|\ \ | | | | | | DOC: Display real license on license page
| * | DOC: Display real license on license pageBen Nathanson2020-10-091-32/+3
| |/ | | | | | | | | Changes license.html to include LICENSE.txt, the real license file. Was showing an out-of-date copy.
* | DOC: Fix empty 'C style guide' page (#17503)Ben Nathanson2020-10-092-10/+2
|/ | | | | Add external link to NEP45 in tocs of dev/index Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* DOC: Fix random links in release note (#17483)Takanori H2020-10-081-4/+3
| | | Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* DOC: Rename 'Quickstart tutorial' (#17504)Ben Nathanson2020-10-081-9/+7
| | | Remove tutorial wording in favor of article, minor wording updates.
* DOC: Use consistent lowercase on docs landing pageBen Nathanson2020-10-071-11/+11
| | | | Corrects titles to all use sentence case, per style guide.
* DOC: Fixing references in ma docstrings (#16300)Takanori H2020-10-071-1/+1
| | | Fix broken links in see also section of some ma functions.
* Merge pull request #17481 from takanori-pskq/i13114-fix-structures-memberMatti Picus2020-10-071-251/+251
|\ | | | | DOC: Fix the entries for members of structures
| * DOC: Fix the entries for members of structurestakanori-pskq2020-10-071-251/+251
| |
* | DOC: rm numpy. from type alias attr definitions.Ross Barnowski2020-10-061-14/+14
| |
* | DOC: Fix broken referencesEric Wieser2020-10-061-32/+32
| | | | | | | | Unfortunately we can't use `np.` as a module name alias
* | DOC: add some missing scalar aliasesEric Wieser2020-10-061-5/+23
|/
* Merge pull request #17464 from takanori-pskq/i13114-add-entriesMatti Picus2020-10-062-75/+112
|\ | | | | DOC: Add some entries for C types and macros
| * Fix: Remove the link for `PyArrayMapIterObject`takanori-pskq2020-10-061-3/+1
| |
| * Fixuptakanori-pskq2020-10-061-2/+2
| |
| * DOC: Add some entries for C types and macrostakanori-pskq2020-10-062-74/+113
| |
* | Merge pull request #17331 from eric-wieser/remove-scalar-tablesMatti Picus2020-10-062-111/+307
|\ \ | |/ |/| DOC: Remove the tables of scalar types, and use `..autoclass` to create link targets instead
| * DOC: typo.Ross Barnowski2020-10-051-1/+1
| |
| * DOC: Overhaul the scalar type documentation to use `..autoclass`Eric Wieser2020-10-041-99/+220
| | | | | | | | | | | | This remove the tables. since they only had three columns, and using the character code is advised against anyway. With this change, the individual scalar types as well as their aliases are now valid sphinx python domain targets.
| * DOC: Change the value of type.__name__ on the scalar types for sphinx buildsEric Wieser2020-10-041-0/+56
| | | | | | | | | | | | | | | | | | | | | | | | | | By default, the `.__name__` of the numeric `np.generic` subclasses is their bitlength name, such as `np.int64`. This is convenient when working interactively, because it lets users see the size of their array easily; but in docs it is confusing, as the sizes of the integers in the doc build may not match their size on the platform of the user reading them. Without this change, `..autoclass:: numpy.short` would just display "alias of uint16", which is backwards. Rather than changing the names globally, or adding a build flag to change the names, this uses `ctypes` to modify the scalar names at startup. This resembles the approach taken by the `forbiddenfruit` module for patching builtin slots, although that would be overkill here. The timing of when we perform this patching is important - we can't do it until after `numpy.core._umath_multiarray` has been loaded, but we need to do it before `numpy.core._add_newdocs` generates the name-based docstrings. Similarly, we can't just disable `numpy.core._add_newdocs` until later, as it populates docstrings in `ndarray` on which `numpy.ma.core` does further processing. To resolve this, we split out the scalar docstrings in `numpy.core._add_newdocs` into a new module `numpy.core._add_newdocs_scalars` that _is_ safe to disable until later.
| * DOC: Improve [source] links for C extension typesEric Wieser2020-10-041-12/+31
| | | | | | | | | | | | Previously, these would all link to `numpy/core/__init__.py`. Now the scalar type and `ndarray` link to the files where the `PyTypeObject` is defined. In future, we should do this for all extension types, probably automatically.
* | Merge pull request #17353 from bjnath/how-to-ioCharles Harris2020-10-054-21/+331
|\ \ | | | | | | DOC: How-to guide for I/O
| * | DOC: Revise credit line per CCBen Nathanson2020-10-031-1/+2
| | | | | | | | | | | | Adds "CC BY 4.0" credit to the Pauli Vertanen example.
| * | DOC: One more bash->python in PR #17353Ben Nathanson2020-09-261-1/+1
| | |
View Lorry Controller Status