pydocstyle
pydocstyle copied to clipboard
PyCQA
docstring style checker
#534 enabled usage of `pydocstyle` with `pyproject.toml` for configuration. In that PR, it was discussed that `toml` shouldn't be a hard dependency for using `pydocstyle` (which I agree with), and...
The new D403 (#165) triggers an error when an extra quotation mark is in the docstring, such as `""""..."""` If the docstring has an extra quotation mark at the end...
Hello, We'd like to start using pydocstyle but the current match & match-dir functionality is making is tricky. We have a test naming convention of `module_test.py` which is different to...
I have function docstring that uses cyrillic symbols. For example: ``` def fun1(self): """Cyrillic я""" pass ``` When I execute pydocstyle it works fine and gives me following FAILURE: `...
When rendering documentation using [Sphinx autodoc](http://www.sphinx-doc.org/en/stable/ext/autodoc.html), the `__init__` method is handled in a special way. The way it is handled depends on the value of [`autoclass_content`](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#confval-autoclass_content). Consider the following simple...
Hi! Numpy and Google-style parameter documentation is great, but some people use [Sphinx-style parameter docs](https://www.sphinx-doc.org/en/master/tutorial/describing-code.html). This PR adds support for those to the D417 checker. This is my first contribution...
D413 says "Missing blank line after last section". It'd be awesome to have the opposite, and raise a new warning when there is a blank line at the end of...
Given this class: ```python class NestedSequence(Protocol[_T_co]): """A protocol for representing nested sequences. Warning ------- `NestedSequence` currently does not work in combination with typevars, *e.g.* ``def func(a: _NestedSequnce[T]) -> T: ...``....
## Problem When an unrelated configuration (ex `semantic_release`) has a literal string, such as a regular expression, in the configuration denoted by `"""`, pydocstyle will throw a `toml.decoder.TomlDecodeError` for an...
Currently when the library `toml` is missing pydocstyle cannot read the `pyproject.toml` file. It would be nice if also other toml reader would be supported ([`tomli`](https://pypi.org/project/tomli/)), resp. with python 3.11...
