summaryrefslogtreecommitdiff
path: root/tools/refguide_check.py
Commit message (Collapse)AuthorAgeFilesLines
* DOC: Nupydoc format space before `:` in ParametersMatthias Bussonnier2021-01-311-7/+5
| | | | Missing `s` in two spellings.
* DOC: Avoid using "set of" when talking about an ordered list.Antony Lee2020-12-291-2/+2
| | | | | | | | | | | | ... or when the input isn't/cannot be a set. I left a few usages, e.g. in random sampling, where "set" is reasonable as informal description of an array as the order doesn't matter; however, for e.g. np.gradient the order of the returned list is clearly important, so "set" is wrong. Also some other minor doc edits noticed during the grepping: using `shape` instead of `form` in `cov` is consistent with most other places; the wording in `Polynomial.trim` now matches other methods on the same class.
* DOC, MAINT: Minor fixes to refguide_check.py documentation.Charles Harris2020-12-181-2/+3
| | | | [travis skip]
* MAINT, DOC: move informational files from numpy.doc.*.py to their *.rst ↵Matti Picus2020-09-021-2/+10
| | | | | | | | | counterparts (#17222) * DOC: redistribute docstring-only content from numpy/doc * DOC: post-transition clean-up * DOC, MAINT: reskip doctests, fix a few easy ones
* MAINT: Remove obsolete conversion to set (#17063)jakobjakobson132020-08-111-2/+2
| | | compare already returns sets, so conversion is redundant
* DOC: Fix typos and cosmetic issuesMartin Michlmayr2020-05-171-1/+1
|
* BLD: Add :doc: to whitelisted roles in refguide_check.Ross Barnowski2020-05-051-1/+1
| | | | | | The refguide_check (which currently runs as part of the CI) fails on :doc: roles in the documentation. Added :doc: to the set of whitelisted role names as it is a valid role in sphinx.
* DOC: fix remaining doc files for refguide_check (#15720)Pierre de Buyl2020-03-261-0/+3
| | | | | * DOC: skip f2py fortran and arrays.nditer cython tests for refguide_check * DOC: fix formatting of doc tests and improper use of nditer
* convert shebang from python to python3 (#15687)Changqing Li2020-03-041-1/+1
| | | | Signed-off-by: Changqing Li <changqing.li@windriver.com>
* Merge pull request #12646 from shoyer/refguide-check-exceptionsMatti Picus2020-02-281-1/+1
|\ | | | | TST: check exception details in refguide_check.py
| * TST: check exception details in refguide_check.pyStephan Hoyer2019-01-011-1/+1
| | | | | | | | xref GH-12548
* | Merge pull request #15465 from mwtoews/importsSebastian Berg2020-02-071-1/+0
|\ \ | | | | | | MAINT: cleanup unused imports; avoid redefinition of imports
| * | MAINT: cleanup unused imports; avoid redefinition of importsMike Taves2020-02-061-1/+0
| | | | | | | | | | | | | | | | | | | | | * Cleanup unused imports (F401) of mostly standard Python modules, or some internal but unlikely referenced modules * Where internal imports are potentially used, mark with noqa * Avoid redefinition of imports (F811)
* | | TST: Fix missing output in refguide-checkSeth Troisi2020-02-051-0/+1
|/ /
* | Merge pull request #15430 from sethtroisi/refguide_warningMatti Picus2020-02-031-46/+32
|\ \ | | | | | | MAINT: Use contextmanager in _run_doctests
| * | DEV: More contextmanager in _run_doctestsSeth Troisi2020-01-241-43/+33
| | |
| * | DEV: Use contextmanager in _run_doctestsSeth Troisi2020-01-241-43/+39
| | |
* | | Merge pull request #15464 from sethtroisi/refguide_dup_lineMatti Picus2020-01-291-2/+0
|\ \ \ | | | | | | | | MAINT: Cleanup duplicate line in refguide_check
| * | | MAINT: Cleanup duplicate line in refguide_checkSeth Troisi2020-01-291-2/+0
| | | |
* | | | Merge pull request #15417 from sethtroisi/python2_easyMatti Picus2020-01-291-6/+0
|\ \ \ \ | |/ / / |/| | | MAINT: Cleanup references to python2
| * | | MAINT: Python2 CleanupsSeth Troisi2020-01-281-6/+0
| |/ /
* | | DOC: Update refguide_check note on how to skip codeSeth Troisi2020-01-281-0/+8
|/ /
* | [MAINT] Cleanup python2 sys.version checksSeth Troisi2020-01-201-13/+9
| |
* | MAINT: Remove implicit inheritance from object class (#15236)Jon Dufresne2020-01-051-1/+1
| | | | | | | | | | | | | | 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-031-2/+0
| | | | | | | | | | As numpy is Python 3 only, these import statements are now unnecessary and don't alter runtime behavior.
* | Implemented review feedbacks #14961Sanjeev Kumar2019-12-051-12/+23
| |
* | Added documentation in methodsSanjeev Kumar2019-12-051-23/+207
| |
* | Fix typosBrian Wignall2019-11-251-2/+2
| |
* | MAINT: remove deprecation warningsmattip2019-11-221-4/+4
| |
* | MAINT: fixes from reviewmattip2019-11-181-2/+2
| |
* | MAINT: fixes from reviewmattip2019-11-161-6/+17
| |
* | MAINT: pep8, remove checks of *.py files from --rst checkmattip2019-11-011-9/+10
| |
* | MAINT: fixes from reviewmattip2019-10-311-12/+27
| |
* | TST: changes from reviewmattip2019-10-171-27/+21
| |
* | TST: run refguide-check on rst files in doc/*mattip2019-10-171-70/+148
| |
* | DOC: Change random to uninitialized and unpredictable in empty and ↵Kexuan Sun2019-06-151-1/+2
| | | | | | | | | | | | empty_like (#13771) * DOC: Change "random" to "uninitialized" in doctests
* | DOC: fixes from reviewmattip2019-02-281-1/+1
| |
* | TEST: activate doctests on doc.structured_arrays, fix for pure doc modulemattip2019-01-141-1/+5
| |
* | ENH: add "max difference" messages to np.testing.assert_array_equal (#12591)Stephan Hoyer2019-01-011-0/+1
|/ | | | | | | | | | | | | | | | | | | | | | Example behavior: >>> x = np.array([1, 2, 3]) >>> y = np.array([1, 2, 3.0001]) >>> np.testing.assert_allclose(x, y) AssertionError: Not equal to tolerance rtol=1e-07, atol=0 Mismatch: 33.3% Max absolute difference: 0.0001 Max relative difference: 3.33322223e-05 x: array([1, 2, 3]) y: array([1. , 2. , 3.0001]) Motivation: when writing numerical algorithms, I frequently find myself experimenting to pick the right value of `atol` and `rtol` for `np.testing.assert_allclose()`. If I make the tolerance too generous, I risk missing regressions in accuracy, so I usually try to pick the smallest values for which tests pass. This change immediately reveals appropriate values to use for these parameters, so I don't need to guess and check.
* MAINT: include recfunctions moduleTyler Reddy2018-12-141-0/+1
| | | | | | | | | * added lib.recfunctions to refguide PUBLIC_SUBMODULES, as the doctests were otherwise not getting executed * fixed a failing doctest in recfunctions after above activation
* TST, DOC: enable refguide_checkTyler Reddy2018-12-141-0/+951
* 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