summaryrefslogtreecommitdiff
path: root/numpydoc
Commit message (Collapse)AuthorAgeFilesLines
* MAINT: Refactoring `get_doc_object` (#452)HEADmainyuki2023-03-142-23/+23
|
* Update pre-commit (#449)Jarrod Millman2023-02-013-4/+1
| | | | | * Update pre-commit * Run pre-commit on all files
* BUG: PR06 logic to only fail when type is used standalone (#447)Bryce Mecum2023-01-242-1/+36
| | | | | | | Change PR06 logic to only fail when type is used standalone. This prevents failures for user-defined classes, e.g. Mystring Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* Bump versionJarrod Millman2022-10-081-1/+1
|
* Designate 1.5.0 releasev1.5.0Jarrod Millman2022-10-081-1/+1
|
* Bump versionJarrod Millman2022-10-041-1/+1
|
* Designate 1.5.0rc1 releasev1.5.0rc1Jarrod Millman2022-10-041-1/+1
|
* Add cached property support (#433)Ross Barnowski2022-09-282-1/+29
| | | | | | | | | | | * TST: Add test case for cached_property. * BUG: Fix detection of cached_property attrs. Co-authored-by: Tirth Patel <tirthasheshpatel@gmail.com> * Wrap cached_property import in try/except for Python 3.7. Co-authored-by: Tirth Patel <tirthasheshpatel@gmail.com>
* BUG: Fix returns parsing no name (#429)Ross Barnowski2022-09-162-3/+22
| | | | | | | | | * TST: Add test case. * MAINT: Adjust logic for parameter lines with : char. Adjust logic in parameter line splitting to avoid bug where Returns objects containing sphinx roles are improperly parsed.
* ENH: Update validate.py to allow parameters with trailing underscores. (#425)Stefanie Molin2022-08-252-1/+26
| | | | | | | | | | | * Update validate.py to allow parameters with trailing underscores. * Add test to ensure that escaping trailing underscores in parameters is accounted for. * Update test_validate.py * Fix spacing in test case. * Add parameters_with_trailing_underscores to test_good_functions()
* Remove numpydoc_use_blockquotes (#422)Jarrod Millman2022-08-154-57/+2
| | | | | | | * Remove numpydoc_use_blockquotes See https://github.com/numpy/numpydoc/pull/107 * Update docstring
* Require sphinx>=4.2 (cleanup) (#421)Jarrod Millman2022-08-091-2/+2
|
* Require sphinx>=4.2 (#411)Jarrod Millman2022-07-291-26/+0
|
* docs: fix validation include line numbers (#418)Jeremy Goh2022-07-181-0/+6
| | | | | | | | | * docs: fix validation include line numbers * use start/end markers instead of hardcoding lineno * Add missing sentinel + explanatory comment. Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* ENH: Add support for dict show_inherited_class_members (#415)Eric Larson2022-07-132-3/+42
| | | | | | | * ENH: Add support for dict show_inherited_class_members * STY: Black * TST: Add test
* Bump versionJarrod Millman2022-06-091-1/+1
|
* Designate 1.4 releasev1.4.0Jarrod Millman2022-06-091-1/+1
|
* Bump versionJarrod Millman2022-06-081-1/+1
|
* Designate 1.4.0rc1 releasev1.4.0rc1Jarrod Millman2022-06-081-1/+1
|
* Use node.findall if available (docutils 18.x) (#403)Daniel McCloy2022-06-022-7/+33
| | | | | | | | | | | | | | | | | | * use node.findall if available (docutils 18.x) * fix test_reference * keep test_reference backwards-compatible * Add comments about when triage becomes unnecessary/obsolete Co-authored-by: Jarrod Millman <jarrod.millman@gmail.com> * whitespace * fix docutils version as noted in docstring Co-authored-by: Jarrod Millman <jarrod.millman@gmail.com> Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
* Run black formatterJarrod Millman2022-05-0716-885/+1049
|
* Bump versionJarrod Millman2022-04-301-1/+1
|
* Designate 1.3.1 releasev1.3.1Jarrod Millman2022-04-301-1/+1
|
* Bump versionJarrod Millman2022-04-301-1/+1
|
* Bump versionJarrod Millman2022-04-291-1/+1
|
* Designate 1.3 releasev1.3.0Jarrod Millman2022-04-291-1/+1
|
* Bump versionJarrod Millman2022-04-251-1/+1
|
* Designate 1.3rc1 releasev1.3rc1Jarrod Millman2022-04-251-1/+1
|
* Require sphinx>3 (#385)Jarrod Millman2022-04-251-2/+2
|
* Update tests + coverage config to rm warnings. (#383)Ross Barnowski2022-04-181-1/+2
| | | | | | | Replace deprecated pytest behavior with suggested warnings.catch_warnings. Remove include from coverage configuration as it is ignored when source is set.
* MAINT: Dont import for version (#382)Eric Larson2022-04-142-1/+2
| | | | | | | | | * MAINT: Dont import for version * FIX: Sp * FIX: Add * STY: PEP
* Runtime verification of sphinx and jinja2 versions (#381)Ross Barnowski2022-04-131-0/+25
| | | | | | | * Add runtime sphinx/jinja version checker. * Remove jinja2 pin. * modify CI to account for removed pin.
* Add pre-commit hook / linter (#374)Jarrod Millman2022-04-056-13/+10
| | | | | | | * Add pre-commit hook / linter * Run linter * Fix GH workflow
* Cleanup cruft (#371)Jarrod Millman2022-03-301-8/+1
|
* Remove deprecated numpydoc_edit_link (#372)Jarrod Millman2022-03-302-12/+0
| | | Deprecated in 2017
* Bump versionJarrod Millman2022-03-291-1/+1
|
* Designate 1.2.1 releasev1.2.1Jarrod Millman2022-03-291-1/+1
|
* Use isgeneratorfunction to avoid overgenerating YD01 (#368)Joel Nothman2022-03-161-1/+5
| | | Fixes #365
* Fix AttributeError in underline length check (#363)Ross Barnowski2022-01-262-1/+33
| | | | | | | | | | | | | | | | | * Add test for bad behavior. Fix test. * Add test for bad behavior. * Improve object name introspection Co-authored-by: Eric Larson <larson.eric.d@gmail.com> * Improve test specificity for name introspection Co-authored-by: Eric Larson <larson.eric.d@gmail.com> Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
* Bump versionJarrod Millman2022-01-241-1/+1
|
* Designate 1.2 releasev1.2.0numpydoc-1.2Jarrod Millman2022-01-241-1/+1
|
* Bump versionJarrod Millman2022-01-201-1/+1
|
* Designate 1.2rc1 releasenumpydoc-1.2rc1Jarrod Millman2022-01-201-1/+1
|
* Use fstrings (#353)Jarrod Millman2022-01-106-41/+38
| | | Convert string formatting to f-strings with flynt
* Require sphinx >= 1.8 (#352)Jarrod Millman2022-01-103-11/+4
|
* Fix typos found by codespell (#343)Dimitri Papadopoulos Orfanos2022-01-091-4/+4
|
* Fix validation bug when parameter type is set of options. (#347)Ross Barnowski2022-01-072-0/+27
| | | | | * Add test case. * Fix validation error when param_type is set of options.
* Escape newline in docstring. (#345)Matthias Bussonnier2021-12-271-1/+1
| | | Otherwise `'.` is seen as the second parameter.
* Avoid mutable default arguments (#342)Dimitri Papadopoulos Orfanos2021-12-164-12/+30
| | | | | | | While they are not always an actual bug, they are certainly a Python anti-pattern and possible the source of future bugs. In at least one case, the default mutable argument `config` is actually modified later on by the function.
* Correctly validate parameters under the "Other Parameters" section (#337)dcbr2021-11-052-13/+53
| | | | | | | | | * Fix invalid "PR01" error when parameter is specified in "Other Parameters" section. * Fix 'foo' docstring in doc/example.py * Change "PR03" (wrong parameters order) validation test * Revert "PR03" changes.
View Lorry Controller Status