docstripy.google#

docstripy.google.build_doc#

Docstring building functions for numpy style.

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

Build docstring for google style.

Return type:

List[str]

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

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

Return type:

List[str]

docstripy.google.parse_doc#

Parser for Google style docstrings.

parse_params(lines, section_name)#

Parse parameter section from Google format.

Parameters:

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

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

Return type:

List[dict]

parse_sections_ranges(lines)#

Parse google sections of a docstring.

Return type:

Dict

parse_wild_sections_ranges(lines)#

Parse wild sections of a docstring from google format.

Return type:

Dict

is_define_section(line)#

Check if a line define a Google wild section or not.

Return type:

bool