summaryrefslogtreecommitdiff
path: root/doc/example.py
Commit message (Collapse)AuthorAgeFilesLines
* Run black formatterJarrod Millman2022-05-071-1/+1
|
* Add pre-commit hook / linter (#374)Jarrod Millman2022-04-051-1/+0
| | | | | | | * Add pre-commit hook / linter * Run linter * Fix GH workflow
* Correctly validate parameters under the "Other Parameters" section (#337)dcbr2021-11-051-7/+9
| | | | | | | | | * 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 missing periods (#298)Albert Villanova del Moral2020-09-031-2/+2
|
* ENH: Add args and kwargs to example (#258)Eric Larson2020-04-121-1/+5
|
* STY: Reword first lines of example.py docstrings (#246)Justin Ludwig2019-11-271-4/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * STY: Reword first lines of example.py docstrings Running doc/example.py through [pydocstyle](http://www.pydocstyle.org/) using the "numpy" conventions turns up the following violations for the module docstring: * D205: 1 blank line required between summary line and description (found 0) * D400: First line should end with a period (not 'd') * D404: First word of the docstring should not be `This` * D415: First line should end with a period, question mark, or exclamation point (not 'd') And the following violation for the `foo()` function docstring: * D401: First line should be in imperative mood; try rephrasing (found 'A') This change slightly rewords the first line of both docstrings to better model how docstrings should begin: 1. It reformats the module docstring to place the first sentence on its own line, and remove the superflous "This is the" introduction. 2. It rewords the `foo()` function docstring to rephrase the first line as a command (following the PEP 257 convention). After this change, pydocstyle finds no violations. * BLD: run pydocstyle on example.py in travis
* Minor style improvements to doc/example.py to pass validation (#243)Roman Yurchak2019-11-041-4/+2
|
* DOC: Add description for blank lines after the docstring. (#229)YaOzI2019-08-021-1/+4
|
* MAINT: doctest and pytest (#225)Eric Larson2019-06-031-1/+1
| | | | | | * MAINT: doctest and pytest * BUG: Dependency missing
* Py3fy some doctests. (#224)Antony Lee2019-05-311-2/+2
|
* ENH: Just use objEric Larson2019-04-171-4/+4
|
* DOC: Add missing backslash to omega for inline math example.Paul van Mulbregt2018-04-121-1/+1
|
* Handle case where description is empty (#140)Joel Nothman2017-11-041-0/+1
|
* Basic docs based on Numpy's HOW_TO_DOCUMENT.rst.txtJoel Nothman2017-10-231-0/+122