docstripy.numpy#

docstripy.numpy.build_doc#

Docstring building functions for numpy style.

build_doc_numpy(current_docstring, sections_dict, max_len, indent, *, include_type=True)#

Build docstring for numpy style.

Return type:

List[str]

build_section_params_numpy(param_dicts, max_len, indent, *, include_type=True)#

Build parameters, returns, raises, and attributes sections for numpy style.

Return type:

List[str]

docstripy.numpy.parse_doc#

Parser for Numpy style docstrings.

parse_params(lines, section_name='param')#

Parse parameter section from Numpy format.

Parameters:

  • lines (List[str]) – Lines of docstring.

  • section_name (str, optional) – Name of the section, one of “param”, “return”, “attribute”, “raises”. By default, “param”.

Return type:

List[dict]

parse_sections_ranges(lines)#

Parse numpy sections of a docstring.

Return type:

Dict

parse_wild_sections_ranges(lines)#

Parse wild sections of a docstring from numpy format.

Return type:

Dict