summaryrefslogtreecommitdiff
path: root/doc/source/reference
Commit message (Collapse)AuthorAgeFilesLines
...
| * DOC: Added `show_runtime` to Utilityganesh-k132022-08-191-0/+1
| |
* | Merge pull request #22122 from rkern/doc/sequence-of-seedsCharles Harris2022-08-182-2/+84
|\ \ | |/ |/| DOC: Explain how to use sequences of integers as seeds.
| * DOC: Explain how to use sequences of integers as seeds.Robert Kern2022-08-132-2/+84
| |
* | DOC: Fix intersphinx inventory namesmelissawm2022-08-151-2/+2
|/ | | | Since Sphinx 5.0.0, some intersphinx links need explicit inventory names or they won't be resolved correctly. See https://www.sphinx-doc.org/en/master/changes.html\#release-5-0-0-released-may-30-2022 and https://github.com/sphinx-doc/sphinx/issues/2068.
* DOC: updated masked_print_option and added explanation (#22013)Miki Watanabe2022-07-201-3/+4
| | | | | | | Fix misspelling in masked_print_option data entry and add explanation on how to change the value. Co-authored-by: 渡邉 美希 <miki.watanabe@watanabenoMacBook-Pro.local> Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* Merge pull request #21837 from seberg/note-objects-nullCharles Harris2022-07-121-0/+23
|\ | | | | DOC: Document expectation for object array initialization
| * DOC: Adopt changes as suggested in reviewSebastian Berg2022-07-051-2/+3
| | | | | | | | Co-authored-by: Charles Harris <charlesr.harris@gmail.com>
| * DOC: Document expectation for object array initializationSebastian Berg2022-06-231-0/+22
| | | | | | | | | | | | | | | | | | | | | | | | | | This documents (and thus semi-establishes) that we try to make sure that any array that may be *read* is fully initialized with proper Python objects (not NULL). However, try to write in a way that clearly says that users are not allowed to rely on this. I somewhat suspect there are more code paths where we may to fail fully initializing object arrays... It does promise to regard such things as bugs, if we do not want that, I am happy to just tell users to expect NULLs.
* | DOC: Add a note about security and NumPy to the documentation (#21927)Sebastian Berg2022-07-102-0/+62
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * DOC: Add a note about security and NumPy to the documentation The main plan is to have something to point to when we get "security adviseries" for issues where it is necessary to trigger very exact bugs in impossible places, or just require direct API access to begin with. Neither of this is a serious security issue. I thought it might be good to make a note that e.g. structured dtypes are a big complexity source that one should maybe be careful about. * DOC: Apply review suggestions Co-authored-by: Leo Fang <leofang@bnl.gov> * DOC: Incorporate review suggestions for security docs Co-authored-by: Ralf Gommers <ralf.gommers@gmail.com> * Update doc/source/reference/security.rst Co-authored-by: Ross Barnowski <rossbar@berkeley.edu> * Update doc/source/reference/security.rst Co-authored-by: Ross Barnowski <rossbar@berkeley.edu> Co-authored-by: Leo Fang <leofang@bnl.gov> Co-authored-by: Ralf Gommers <ralf.gommers@gmail.com> Co-authored-by: Charles Harris <charlesr.harris@gmail.com> Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* | Merge pull request #21248 from ax3l/doc-improve-array-interface-dataMatti Picus2022-07-081-3/+9
|\ \ | |/ |/| DOC: improve description of the `data` entry in `__array_interface__`
| * DOC: Apply final wording suggestion.Ross Barnowski2022-07-081-5/+9
| | | | | | | | Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>.
| * DOC: Improve Array Interface `data`Axel Huebl2022-03-261-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | The previous guidance on the integer type of `data` was a bit misleading in practice and has now been improved. In practice, Unix is fine with `int` (32bit) and `long` (64bit), but Windows requires `long long` to hold a pointer. https://en.cppreference.com/w/cpp/language/types In order not to complicate the guidance, recommend the `intptr_t` type explicitly.
* | MAINT: limit the number of decimals in Polynomial representation (#21654)Lev Maximov2022-06-141-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * limit the number of decimals in Polynomial representation * tests pass * parenthesize exponential notation in polynomials * fixed a long line warning * added polynomial printoptions tests * polynomial printoptions typo fixed * made switch to exp notation in polynomial display more natural * added a test on switching polynomials to exp notation * fixed linter errors/warnings * support for nanstr and infstr printoptions in polynomials * 10^8 threshold for switching to exp notation when displaying polynomials * merged in PR #21696 fixing issue #21695 * made linter happy * made some docstring tests pass * fixed the docs Co-authored-by: Lev Maximov <lev.maximov@gmail.com>
* | Mention positional-only arguments in the array API compatibility docAaron Meurer2022-06-081-0/+5
| | | | | | | | | | I forgot to mention them, but they are important because this would be a breaking change.
* | DOC: RST Titles Underline reordering (#21677)Matthias Bussonnier2022-06-0824-101/+101
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * ~ not ^ * = skipped for - * swap - and = underline in files they are swapped * * to = in header underline * - to = and * to - for consitency * A few more change * -> ~ * use ~ instead of + * DOC: Fixup `c-api/array.rst` with further ^ with ~ replacement There is still a fourth level here, which remains using " Co-authored-by: Sebastian Berg <sebastian@sipsolutions.net>
* | DIC: Misc RST reformatting.Matthias Bussonnier2022-06-035-30/+30
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This contains various RST reformatting. One, moving `(C)` one line up, is specific to a bug in tree-sitter-rst that mis parses this section. Another is adding one black line for a similar reason where `..` is seen as section underline by tree-sitter-rst. This is some shuffling of section underline: try to be consitant, `=`, then `-`, then `~`, with this refactor there is also no more section that use backticks as underline. Note in particular that non-consitency of underline lead to a problem in datetime64 section where "weekmasks" (underlined with `-`) were actually a level-4 heading instead of a level 2 or 3 I guess, and thus were nested under the `busday_count()` section. You'll note also 2 formulas that are under double-quotes as they are not references.
* | ENH: Add support for symbol to polynomial package (#16154)Ross Barnowski2022-06-012-27/+27
| | | | | | | | | | | | | | Adds a symbol attribute to the polynomials from the np.polynomial package to allow the user to control/modify the symbol used to represent the independent variable for a polynomial expression. This attribute corresponds to the variable attribute of the poly1d class from the old np.lib.polynomial module. Marked as draft for now as it depends on #15666 - all _str* and _repr* methods of ABCPolyBase and derived classes would need to be modified (and tested) to support this change. Co-authored-by: Warren Weckesser <warren.weckesser@gmail.com>
* | MAINT: Changed reference to multiple filesShoban Chiddarth2022-05-242-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Changed files are - doc/HOWTO_RELEASE.rst - doc/Makefile - doc/changelog/1.15.0-changelog.rst - doc/changelog/1.16.0-changelog.rst - doc/changelog/1.17.0-changelog.rst - doc/changelog/1.19.0-changelog.rst - doc/changelog/1.21.0-changelog.rst - doc/neps/nep-0045-c_style_guide.rst - doc/source/dev/howto_build_docs.rst - doc/source/dev/releasing.rst - doc/source/reference/distutils_guide.rst - doc/source/reference/testing.rst - doc/source/release/1.7.0-notes.rst - doc/source/release/1.8.0-notes.rst
* | DOC: fix documentation for typedescr argument of PyArray_AsCArrayMarkus Mohrhard2022-05-141-9/+6
| | | | | | | | | | The PyArray_AsCArray API does not conform to the documentation and document that the call steals a reference to the PyArray_Descr argument.
* | Merge pull request #20020 from joukewitteveen/ma-ndenumerateMatti Picus2022-05-111-0/+1
|\ \ | | | | | | ENH: add ndenumerate specialization for masked arrays
| * | ENH: add ndenumerate specialization for masked arraysJouke Witteveen2022-04-221-0/+1
| | |
* | | ENH: Apply suggested changeThomas Duvernay2022-05-061-1/+0
| | | | | | | | | Co-authored-by: Matti Picus <matti.picus@gmail.com>
* | | DOC: Add missing functions in `numpy.testing` documentationThomas Duvernay2022-04-261-0/+7
|/ /
* | Merge pull request #21032 from jon-deng/fix-sphinx-doc-errorsMatti Picus2022-04-201-4/+4
|\ \ | | | | | | DOC: fix sphinx errors due to np.emath references
| * | DOC: Fix formatting for routines.emath.rst titleJonathan Deng2022-03-051-1/+1
| | |
| * | DOC: Fix missing lib.scimath module referenceJonathan Deng2022-03-031-1/+1
| | |
| * | DOC: Remove routines.lib.scimath.rstJonathan Deng2022-03-032-10/+1
| | |
| * | Merge branch 'main' into fix-sphinx-doc-errorsJonathan Deng2022-03-027-43/+271
| |\ \
| * | | DOC: Fix broken links to numpy.emath moduleJonathan Deng2022-02-252-2/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are a number of broken links to the numpy.emath module because there are no generated documentation for numpy.emath, which is an alias of numpy.lib.scimath. This fixes the broken links by generating documentation for numpy.emath, that duplicates the documentation for numpy.lib.scimath.
* | | | Merge pull request #21327 from asmeurer/array-api-doc-updatesMatti Picus2022-04-121-5/+4
|\ \ \ \ | | | | | | | | | | Small updates to the array_api docs
| * | | | Small updates to the array_api docsAaron Meurer2022-04-111-5/+4
| | | | | | | | | | | | | | | | | | | | | | | | | These items were not clear in the original PR #21260 but have since been clarified.
* | | | | DOC: various spell checks and typo fixes (#21314)Logan Thomas2022-04-102-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * DOC: contigous -> contiguous * DOC: enlongated -> elongated * DOC: thuse -> thus * DOC: quantityt -> quantity * DOC: suppled -> supplied * DOC: intgrally -> integrally * DOC: assignnent -> assignment * DOC: homoegeneous -> homogeneous * DOC: interpereted -> interpreted * DOC: optimised -> optimized * DOC: Advantanges -> Advantages * DOC: realised -> realized * DOC: parametrizing -> parameterizing * DOC: realised -> realized * DOC: intrisics -> intrinsics * DOC: ablility -> ability * DOC: intrisic -> intrinsic * DOC: unversal -> universal * DOC: machnisms -> mechanisms * DOC: specfiy -> specify * DOC: exclution -> exclusion * DOC: optimzations -> optimizations * DOC: declrations -> declarations * DOC: auto-gernreated -> auto-generated * DOC: it highely recomaned -> it is highly recommended * DOC: exectuing -> executing * DOC: strectched -> stretched * DOC: foriegn -> foreign * DOC: indeded -> intended * DOC: multimdimensional -> multidimensional * DOC: supserseded -> superseded * DOC: generalisation -> generalization * FIX: whitespace before comma
* | | | | Merge pull request #21260 from asmeurer/array-api-docsCharles Harris2022-04-042-0/+805
|\ \ \ \ \ | |/ / / / | | | | | Add a document that enumerates the differences between numpy and numpy.array_api
| * | | | Note that keyword arguments with different defaults are breakingAaron Meurer2022-03-301-11/+17
| | | | | | | | | | | | | | | | | | | | | | | | | This applies even of the name changed, because it affects the case where no keyword is passed.
| * | | | Update review comments on the array API documentAaron Meurer2022-03-291-9/+12
| | | | |
| * | | | Add a note about the array API copy flag to reshape (which is not yet ↵Aaron Meurer2022-03-291-0/+3
| | | | | | | | | | | | | | | | | | | | implemented)
| * | | | Address review comments in the array API documentationAaron Meurer2022-03-291-4/+9
| | | | |
| * | | | Add a document that enumerates the differences between numpy and numpy.array_apiAaron Meurer2022-03-282-0/+788
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a more organized presentation of the various "Note" comments in numpy/array_api. In particular, each difference is notated as to whether it is a strictness difference (no change in NumPy needed), a compatible change (NumPy can change in a backwards compatible way), or a breaking change (NumPy would need to break backwards compatibility to match the spec).
* | | | | DOC: Made suggested changes.Bhavuk kalra2022-04-031-1/+1
| | | | | | | | | | | | | | | | | | | | Kept the Python code output uniform
* | | | | DOC: Improve "random.generator.shuffle" docs pagebhavukkalra2022-03-301-0/+2
| |_|_|/ |/| | |
* | | | DOC: fix outdated description of unicodeNimrod2022-03-161-1/+1
|/ / /
* | | DOC: add the DLPack protocol to interpolability docsTirth Patel2022-03-031-1/+2
| | |
* | | MAINT: make np._from_dlpack publicTirth Patel2022-03-031-0/+1
| |/ |/|
* | Merge pull request #20875 from rgommers/deprecate-npdistutilsMatti Picus2022-02-174-0/+150
|\ \ | | | | | | DEP: deprecate `numpy.distutils`, and add a migration guide
| * | MAINT: fix failure due to importing warnings in `distutils/__init__.py`Ralf Gommers2022-02-161-6/+3
| | |
| * | DOC: add section on moving to SetuptoolsRalf Gommers2022-02-151-8/+61
| | | | | | | | | | | | | | | | | | | | | [skip azp] [skip actions] Also addresses review comments.
| * | DEP: deprecate `numpy.distutils`, and add a migration guideRalf Gommers2022-02-154-0/+100
| | |
* | | Merge pull request #20774 from miccoli/doc/datetime-semanticsCharles Harris2022-02-161-18/+111
|\ \ \ | |/ / |/| | DOC: explicitly define numpy.datetime64 semantics
| * | DOC: explicitly define numpy.datetime64 semanticsStefano Miccoli2022-01-101-18/+111
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Explicity state datetime64 semantics: - adoption of proleptic Gregorian Calendar - Astronomical year numbering - 86400 s constant length of day. Add some exmples of shortcomings of the above semnatics with ref. to UTC timescale (missing leap seconds) and UT timescale (variable legth of day). Closes GH-20675
* | | MAINT: Remove the RELAXED_STRIDES_CHECKING env variableSebastian Berg2022-02-112-25/+10
| |/ |/| | | | | | | An error is for now raised in `setup.py` if this is set, eventually we should just delete that.
View Lorry Controller Status