numpydoc
numpydoc copied to clipboard
numpy
Numpy's Sphinx extensions
```python def foo(): """ Quite long line, e.g., because I link to\ something and do not want to upset\ line length rules and keep this\ a single sentence. """ ```...
Not sure if it is just me, but I get the following warning when validating an Enum: ``` WARNING: [numpydoc] Validation warnings while processing docstring for 'b_asic.quantization.Quantization.ROUNDING': GL01: Docstring text...
I have a class like this, ``` class MyClass: """ Summary line. Parameters ---------- a: str Description of ``a``. b: `.SomeType` Description of ``b``. c: float Description of ``c``. """...
type-only values as in ``` Returns ------- int ``` should be in italics for consistency with the `parameter_name : int` style, where `int` would be in italics. Possible reason not...
Trailing underscores in types in the `Parameters` and `Returns` sections have to be escaped in order to not give an `Unknown target name` warning. Examples that DON'T work : ```python...
Add the special case for constant, and try to separate semantic (can link), to style (monospace, link) See also #525
Before, the only way to specify ignores is as: ``` numpydoc lint filename --ignore EX01 SA01 ``` and multiple invocations of the ignore flag overwrote one another. Instead, ignored checks...
Point back at pyproject.toml this might avoid a pre-commit and avoid out of sync things.
The See Also section raises a ValueError when it encounters a valid sphinx cross-reference such as ```rst :meth:`QImage.save ` ``` This commit allows the regex to parse the sphinx target,...
