pydoclint

pydoclint style violation codes

Table of Contents

Code	Explanation
`DOC001`	Potential formatting errors in docstring

Code	Explanation
`DOC101`	Docstring contains fewer arguments than in function signature
`DOC102`	Docstring contains more arguments than in function signature
`DOC103`	Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103)
`DOC104`	Arguments are the same in the docstring and the function signature, but are in a different order.
`DOC105`	Argument names match, but type hints do not match
`DOC106`	The option `--arg-type-hints-in-signature` is `True` but there are no argument type hints in the signature
`DOC107`	The option `--arg-type-hints-in-signature` is `True` but not all args in the signature have type hints
`DOC108`	The option `--arg-type-hints-in-signature` is `False` but there are argument type hints in the signature
`DOC109`	The option `--arg-type-hints-in-docstring` is `True` but there are no type hints in the docstring arg list
`DOC110`	The option `--arg-type-hints-in-docstring` is `True` but not all args in the docstring arg list have type hints
`DOC111`	The option `--arg-type-hints-in-docstring` is `False` but there are type hints in the docstring arg list

Other potential causes to DOC103 include:

Numpy docstring style requires this style: arg1 : int (a space between arg1 and :) but people sometimes write arg1: int. This will trigger DOC103.
In the Google style, writing an Args: section without the preceding summary will also trigger DOC103.

Code	Explanation
`DOC201`	Function/method does not have a return section in docstring
`DOC202`	Function/method has a return section in docstring, but there are no return statements or annotations
`DOC203`	Return type(s) in the docstring not consistent with the return annotation

Note on DOC201: Methods with @property as its last decorator do not need to have a return section.

Code	Explanation
`DOC301`	`__init__()` should not have a docstring; please combine it with the docstring of the class
`DOC302`	The class docstring does not need a “Returns” section, because `__init__()` cannot return anything
`DOC303`	The `__init__()` docstring does not need a “Returns” section, because it cannot return anything
`DOC304`	Class docstring has an argument/parameter section; please put it in the `__init__()` docstring
`DOC305`	Class docstring has a “Raises” section; please put it in the `__init__()` docstring
`DOC306`	The class docstring does not need a “Yields” section, because `__init__()` cannot yield anything
`DOC307`	The `__init__()` docstring does not need a “Yields” section, because `__init__()` cannot yield anything

Code	Explanation
`DOC401`	(Deprecated; this violation code no longer appears)
`DOC402`	Function/method has “yield” statements, but the docstring does not have a “Yields” section
`DOC403`	Function/method has a “Yields” section in the docstring, but there are no “yield” statements, or the return annotation is not a Generator/Iterator/Iterable
`DOC404`	The types in the docstring’s Yields section and the return annotation in the signature are not consistent

Code	Explanation
`DOC501`	Function/method has “raise” statements, but the docstring does not have a “Raises” section
`DOC502`	Function/method has a “Raises” section in the docstring, but there are not “raise” statements in the body
`DOC503`	Exceptions in the “Raises” section in the docstring do not match those in the function body

Code	Explanation
`DOC601`	Class docstring contains fewer class attributes than actual class attributes.
`DOC602`	Class docstring contains more class attributes than in actual class attributes.
`DOC603`	Class docstring attributes are different from actual class attributes.
`DOC604`	Attributes are the same in docstring and class def, but are in a different order.
`DOC605`	Attribute names match, but type hints in these attributes do not match

More about checking class attributes: https://jsh9.github.io/pydoclint/checking_class_attributes.html

This site is open source. Improve this page.