summaryrefslogtreecommitdiff
path: root/numpy/doc
Commit message (Collapse)AuthorAgeFilesLines
* MAINT, DOC: discard repeated wordsDimitri Papadopoulos2022-01-131-1/+1
|
* MAINT: Remove encoding declarations: # -*- coding: utf-8 -*-Dimitri Papadopoulos2021-10-061-1/+0
| | | | In Python 3, the default source file encoding is UTF-8.
* DOC: rm see also ref to doc.indexing.Ross Barnowski2020-09-091-4/+0
| | | | Indexing article no longer exists
* Fix docstring cross-referencingAlbert Villanova del Moral2020-09-041-1/+1
|
* MAINT, DOC: move informational files from numpy.doc.*.py to their *.rst ↵Matti Picus2020-09-0211-3807/+0
| | | | | | | | | counterparts (#17222) * DOC: redistribute docstring-only content from numpy/doc * DOC: post-transition clean-up * DOC, MAINT: reskip doctests, fix a few easy ones
* DOC: Correct error in description of ndarray.baseRyan Soklaski2020-08-281-2/+2
| | | Found in subsection of Subclassing ndarray in python: Extra gotchas - custom __del__ methods and ndarray.base
* DOC: Tweak a sentence about broadcasting.Warren Weckesser2020-07-021-2/+2
| | | | | | * Make clear that "trailing" means the "rightmost" dimensions. * Instead of saying "works its way forward" (forward?), say "works its way left".
* DOC: Use intersphinx for NEP referencesBen Nathanson2020-06-041-1/+1
| | | | | | | | | | | | | Per #16500 discussion, adds link updates to PR. Replaces NEP URLs with intersphinx links in these files: * doc/HOWTO_RELEASE.rst.txt * doc/source/dev/howto-docs.rst * numpy/doc/dispatch.py * numpy/lib/format.py and incorporates @rossbar's #16502 change of `config.py`.
* DOC: Fix spelling typo - homogenous to homogeneous. (#16324)Kevin Moore2020-05-211-1/+1
|
* MAINT: Unify casting error creation (outside the iterator)Sebastian Berg2020-05-021-1/+1
|
* DOC: Add missing bracket (gh-16051)Chunlin2020-04-252-2/+2
| | | Add missing closing brackets, script to generate the list in the PR gh-16051.
* DOC: Clarify docs on mixed advanced indexing and slicing (gh-15891)Paul Rougieux2020-04-201-4/+13
| | | | | | It was not clear how to reproduce the slice example with multi dimensional array indexing. I hope the additional example clarifies the equivalence between slice and multi array for new users. Co-Authored-By: Eric Wieser <wieser.eric@gmail.com> Co-Authored-By: Anirudh Subramanian <anirudh2290@apache.org>
* MAINT: simplify code that assumes str/unicode and int/long are different ↵Eric Wieser2020-03-261-2/+1
| | | | | types (#15816) Cleanup from the dropping of python 2
* STY,MAINT: avoid 'multiple imports on one line' (flake8 E401)Mike Taves2020-01-281-1/+2
| | | | | | * PEP 8: "Imports should usually be on separate lines" * Where modified, sort imported modules alphabetically * Clean-up unused imports from these expanded lines
* MAINT: Implement keyword-only arguments as syntaxEric Wieser2020-01-061-2/+2
| | | | Now that 2.7 is gone, there is no need to pop manually from kwarg dictionaries.
* MAINT: Remove implicit inheritance from object class (#15236)Jon Dufresne2020-01-052-3/+3
| | | | | | | Inheriting from object was necessary for Python 2 compatibility to use new-style classes. In Python 3, this is unnecessary as there are no old-style classes. Dropping the object is more idiomatic Python.
* MAINT: Remove unnecessary 'from __future__ import ...' statementsJon Dufresne2020-01-0313-15/+0
| | | | | As numpy is Python 3 only, these import statements are now unnecessary and don't alter runtime behavior.
* Fix typos, via a Levenshtein-style correctorBrian Wignall2019-12-191-1/+1
|
* MAINT: Remove uses of scalar aliasesEric Wieser2019-11-131-2/+2
| | | | Relates to gh-6103
* DOC: add comment to explain `object.__new__`.Ralf Gommers2019-08-281-0/+1
| | | | [ci skip]
* DOC: fix issue with __new__ usage in subclassing doc.Ralf Gommers2019-08-281-1/+1
| | | | Closes gh-14386.
* DOC: Clarify rules about broadcasting when empty arrays are involved. (#14313)Maxwell Aladago2019-08-261-2/+1
| | | * DOC: clarified rules about broadcasting when empty arrays are involved.
* DOC: Fix a minor typo in dispatch documentation.Dan Allan2019-08-241-1/+1
|
* DOC: Address typos in dispatch docsMatt McCormick2019-08-141-3/+3
|
* Merge pull request #13979 from danielballan/array-function-high-level-docsCharles Harris2019-07-141-0/+271
|\ | | | | DOC: Document array_function at a higher level.
| * Improve illustartion of unsupported args.Dan Allan2019-07-141-6/+10
| |
| * Copy editingDan Allan2019-07-141-3/+2
| |
| * Add new section of custom array containers.Dan Allan2019-07-131-0/+268
| |
* | Spellcheck @numpy/doc/broadcasting.pyBastian Eichenberger2019-07-131-2/+2
|/
* Re-add double backlashJohann Faouzi2019-07-091-1/+1
|
* Update basics.pyJohann Faouzi2019-07-091-2/+2
|
* DOC: Fix wrong spelling of ufuncMSeifert042019-07-061-2/+2
|
* BUG: ensure that casting to/from structured is properly checked.Marten van Kerkwijk2019-06-121-5/+2
| | | | | | | | | | Allow unsafe casting from a simple data type to a structured one with multiple fields, but only from structured data type with a single field (checked recursively) to a simple data type. For now, continue to allow any structured to structured with casting="unsafe", as the current can_cast implementation does not match that of "astype".
* DOC: Reorder the constants to have the most useful firstEric Wieser2019-06-011-153/+154
| | | | | | | Previously the constants at the top of the page said words to the effect of "use the one at the bottom of this page instead". Let's just show users those ones first to start with. This commit only re-orders these constants, it does not change any of the descriptions, despite the diff appearing to show that
* MAINT: Misc. typo fixes (#13664)luzpaz2019-05-312-3/+4
| | | | | | * DOC, MAINT: Misc. typo fixes Found via `codespell`
* DOC: Update boolean indices in index arrays with slices exampleOri Broda2019-05-251-0/+7
|
* DOC : Correcting bug on Documentation Page (Byteswapping) (#13262)vrindaaa2019-04-061-10/+10
| | | | | | * Correcting bug on Documentation Page : Byteswapping * Changing name of variable
* Merge pull request #13147 from Kai-Striega/DOC_int_overflowMatti Picus2019-03-191-0/+39
|\ | | | | DOC: Add description of overflow errors
| * DOC: Minor fix in Integer Overflow docKai Striega2019-03-191-3/+3
| | | | | | | | Change `np.power` -> `numpy.power` to make it reference the function's documentation
| * DOC: Remove extra letter from docsKai Striega2019-03-191-1/+1
| |
| * DOC: Add description of overflow errorrskai2019-03-181-0/+39
| | | | | | | | | | | | | | Unlike Python, NumPy integers have fixed sizes. This can lead to confusion when a integer overflow occurs and users expect NumPy integer types to behave similarily to Python integers. This commit explains integer overflow, an example and potential work arounds.
* | DOC: add copy on slicing noticewtli2019-03-141-1/+3
|/
* DOC: fixes from reviewmattip2019-02-281-6/+8
|
* DOC: fixes from reviewmattip2019-02-282-32/+40
|
* DOC: reduce warnings when building, reword, tweak doc buildingmattip2019-02-282-8/+27
|
* DOC: doctest structured array introductionmattip2019-01-141-48/+58
|
* DOC: more doc updates for structured arraysAllan Haldane2018-12-151-0/+9
| | | | [ci skip]
* TST, DOC: enable refguide_checkTyler Reddy2018-12-141-2/+0
| | | | | | | | * ported the refguide_check module from SciPy for usage in NumPy docstring execution/ verification; added the refguide_check run to Azure Mac OS CI * adjusted NumPy docstrings such that refguide_check passes
* ENH: add back the multifield copy->view changeAllan Haldane2018-11-261-46/+62
| | | | | Fixes #10409 Closes #11530
* Merge pull request #11526 from ahaldane/add_struct_helper_funcs_redoCharles Harris2018-11-231-0/+9
|\ | | | | ENH: add multi-field assignment helpers in np.lib.recfunctions