pylint.extensions._check_docs_utils.EpytextDocstring

class documentation

class EpytextDocstring(SphinxDocstring): (source)

View In Hierarchy

Epytext is similar to Sphinx. See the docs: http://epydoc.sourceforge.net/epytext.html http://epydoc.sourceforge.net/fields.html#fields It's used in PyCharm: https://www.jetbrains.com/help/pycharm/2016.1/creating-documentation-comments.html#d848203e314 https://www.jetbrains.com/help/pycharm/2016.1/using-docstrings-to-specify-types.html

Method has_property_returns Undocumented
Class Variable re_param_in_docstring Undocumented
Class Variable re_property_type_in_docstring Undocumented
Class Variable re_raise_in_docstring Undocumented
Class Variable re_returns_in_docstring Undocumented
Class Variable re_rtype_in_docstring Undocumented
Class Variable re_type_in_docstring Undocumented

Inherited from SphinxDocstring:

Method exceptions Undocumented
Method has_params Undocumented
Method has_property_type Undocumented
Method has_returns Undocumented
Method has_rtype Undocumented
Method match_param_docs Undocumented
Method matching_sections Returns the number of matching docstring sections.
Class Variable re_multiple_simple_type Undocumented
Class Variable re_param_raw Undocumented
Class Variable re_property_type_raw Undocumented
Class Variable re_raise_raw Undocumented
Class Variable re_simple_container_type Undocumented
Class Variable re_type Undocumented
Class Variable re_type_raw Undocumented
Class Variable re_xref Undocumented
Class Variable supports_yields True if the docstring supports a "yield" section.

Inherited from Docstring (via SphinxDocstring):

Method __init__ Undocumented
Method __repr__ Undocumented
Method has_yields Undocumented
Method has_yields_type Undocumented
Method params_documented_elsewhere Undocumented
Class Variable re_for_parameters_see Undocumented
Instance Variable doc Undocumented