summaryrefslogtreecommitdiff
path: root/numpydoc/validate.py
Commit message (Collapse)AuthorAgeFilesLines
* BUG: PR06 logic to only fail when type is used standalone (#447)Bryce Mecum2023-01-241-1/+1
| | | | | | | 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>
* ENH: Update validate.py to allow parameters with trailing underscores. (#425)Stefanie Molin2022-08-251-1/+1
| | | | | | | | | | | * 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()
* 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>
* Run black formatterJarrod Millman2022-05-071-26/+25
|
* Use isgeneratorfunction to avoid overgenerating YD01 (#368)Joel Nothman2022-03-161-1/+5
| | | Fixes #365
* Use fstrings (#353)Jarrod Millman2022-01-101-4/+4
| | | Convert string formatting to f-strings with flynt
* Fix validation bug when parameter type is set of options. (#347)Ross Barnowski2022-01-071-0/+4
| | | | | * Add test case. * Fix validation error when param_type is set of options.
* Correctly validate parameters under the "Other Parameters" section (#337)dcbr2021-11-051-13/+25
| | | | | | | | | * 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.
* Fix Warnings section in validate (#335)MatthewFlamm2021-10-251-0/+1
| | | | | * Add Warnings to validate tests * Add Warnings to allowed sections.
* ENH: Enable validation during sphinx-build process (#302)Ross Barnowski2021-02-081-30/+35
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * WIP: Move get_doc_obj to docscrape * WIP: mv _obj property to NumpyDocString * Proof-of-concept: Docstring attrs covered by refactor. Running the test suite on this patch demonstrates that refactoring the boundary between NumpyDocString and SphinxDocString provides the necessary info to (potentially) do away with the validate.Docstring class. * NOTE TO SELF: get_doc_object in docscrape_sphinx * Docstring -> Validator. * Activate validation during sphinx-build. Add a conf option to turn on/off. TODO: test * Replace logger.warn with warning. logger.warn is apparently deprecated * DOC: Add numpydoc_validate to conf docs. * Add mechanism for validation check selection. Adds a config option with a set to allow users to select which validation checks are used. Default is an empty set, which means none of the validation checks raise warnings during the build process. Add documentation for new option and activate in the doc build. * TST: modify how MockApp sets builder app. * TST: Add test of validation warnings. * Specify some sensible validation defaults. * Add docstring name to validation warnings. * Add all keyword to validation_check configuration. More flexibility in configuring which validation checks to run during sphinx build. If 'all' is present, treat the rest of the set as a blocklist, else an allowlist. * Fix failing test. * Make validation error mapping easier to read. * Add check for invalid error codes in configuration. plus test. * Add feature to exclude patterns from docstring validation. Modify updated config name to avoid sphinx warning. Add documentation for exclusion config value. * Be explicit about regex syntax for exclude config val Co-authored-by: Eric Larson <larson.eric.d@gmail.com> * Rm redundant numpydoc_validate config param. Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
* Missed argument renameRoss Barnowski2020-08-171-1/+1
|
* DOC: fix inaccuracy in validate docstring.Ross Barnowski2020-08-121-3/+6
|
* Adding --validate option __main__ and run new validation (#240)Marc Garcia2019-11-131-1/+1
| | | | | | | | * Adding --validate option __main__ and run new validation * Fixing main tests, and minor improvements to the code * Fixing travis negation of exit status
* BUG: Allow no . at end if indented (#239)Eric Larson2019-10-251-27/+32
| | | | | | | | | | | | | | | | | | | | * BUG: Allow no . at end if indented * BUG: Returns, too * MAINT: Simplify * MAINT: Clean up the returns check, too * BUG: Debug cruft * MAINT: Unify * MAINT: Unify sanitizing and processing of desc * STY: Cleaner * STY: extend rather than +=
* Add docstring validation script (from pandas) (#238)Marc Garcia2019-10-241-0/+593
* First version of the script with no pandas stuff (some tests will need to be removed) * Updating tests * Removing the part of the validation that gets the public API objects, and receiving them as a parameter * Updating tests * Fixed bug making examples fail when pytest was called in verbose mode * Replacing pandas by a stdlib module to pass tests when pandas is not available * Making code py2 compatible * Simplified script (just one validate function + Docstring), and removed concept of warning * Fixing imports in py2 * Changing import to see if py2 is happy * Restoring imports, and calling pytest as a module * Getting new changes from pandas sprint, and removing py2 stuff * Fixing import error in tests * Adding tests and removing unused code (improving coverage) * Better implementation of module import based on code review * Remove running examples * Require first letter to be upper case only if it's a letter * Allow one liner docstrings with quotes in the same line.
View Lorry Controller Status