Summary of Undocumented Objects

Method - napoleon.docstring.Field.__init__
Method - napoleon.docstring.FreeFormException.__init__
Instance Variable - napoleon.docstring.FreeFormException.lines
Method - napoleon.docstring.GoogleDocstring._consume_contiguous
Method - napoleon.docstring.GoogleDocstring._consume_empty
Method - napoleon.docstring.GoogleDocstring._consume_field
Method - napoleon.docstring.GoogleDocstring._consume_fields
Method - napoleon.docstring.GoogleDocstring._consume_indented_block
Method - napoleon.docstring.GoogleDocstring._consume_inline_attribute
Method - napoleon.docstring.GoogleDocstring._consume_returns_section
Method - napoleon.docstring.GoogleDocstring._consume_section_header
Method - napoleon.docstring.GoogleDocstring._consume_to_end
Method - napoleon.docstring.GoogleDocstring._consume_to_next_section
Method - napoleon.docstring.GoogleDocstring._dedent
Method - napoleon.docstring.GoogleDocstring._escape_args_and_kwargs
Method - napoleon.docstring.GoogleDocstring._fix_field_desc
Method - napoleon.docstring.GoogleDocstring._format_admonition
Method - napoleon.docstring.GoogleDocstring._format_block
Method - napoleon.docstring.GoogleDocstring._format_docutils_params
Method - napoleon.docstring.GoogleDocstring._format_field
Method - napoleon.docstring.GoogleDocstring._format_fields
Method - napoleon.docstring.GoogleDocstring._get_current_indent
Method - napoleon.docstring.GoogleDocstring._get_indent
Method - napoleon.docstring.GoogleDocstring._get_initial_indent
Method - napoleon.docstring.GoogleDocstring._get_min_indent
Method - napoleon.docstring.GoogleDocstring._indent
Instance Variable - napoleon.docstring.GoogleDocstring._is_in_section
Method - napoleon.docstring.GoogleDocstring._is_indented
Method - napoleon.docstring.GoogleDocstring._is_list
Method - napoleon.docstring.GoogleDocstring._is_section_break
Method - napoleon.docstring.GoogleDocstring._is_section_header
Instance Variable - napoleon.docstring.GoogleDocstring._line_iter
Class Variable - napoleon.docstring.GoogleDocstring._name_rgx
Method - napoleon.docstring.GoogleDocstring._parse
Method - napoleon.docstring.GoogleDocstring._parse_admonition
Method - napoleon.docstring.GoogleDocstring._parse_attribute_docstring
Method - napoleon.docstring.GoogleDocstring._parse_attributes_section
Method - napoleon.docstring.GoogleDocstring._parse_examples_section
Method - napoleon.docstring.GoogleDocstring._parse_generic_section
Method - napoleon.docstring.GoogleDocstring._parse_keyword_arguments_section
Method - napoleon.docstring.GoogleDocstring._parse_methods_section
Method - napoleon.docstring.GoogleDocstring._parse_notes_section
Method - napoleon.docstring.GoogleDocstring._parse_parameters_section
Method - napoleon.docstring.GoogleDocstring._parse_raises_section
Method - napoleon.docstring.GoogleDocstring._parse_references_section
Method - napoleon.docstring.GoogleDocstring._parse_returns_section
Method - napoleon.docstring.GoogleDocstring._parse_see_also_section
Method - napoleon.docstring.GoogleDocstring._parse_warns_section
Instance Variable - napoleon.docstring.GoogleDocstring._parsed_lines
Method - napoleon.docstring.GoogleDocstring._partition_field_on_colon
Instance Variable - napoleon.docstring.GoogleDocstring._process_type_fields
Instance Variable - napoleon.docstring.GoogleDocstring._section_indent
Instance Variable - napoleon.docstring.GoogleDocstring._sections
Method - napoleon.docstring.GoogleDocstring._strip_empty
Instance Variable - napoleon.docstring.GoogleDocstring._what
Method - napoleon.docstring.ITokenizer.__init__
Method - napoleon.docstring.NumpyDocstring._consume_fields
Method - napoleon.docstring.NumpyDocstring._consume_returns_section
Method - napoleon.docstring.NumpyDocstring._consume_section_header
Method - napoleon.docstring.NumpyDocstring._escape_args_and_kwargs
Method - napoleon.docstring.NumpyDocstring._is_section_break
Method - napoleon.docstring.NumpyDocstring._is_section_header
Method - napoleon.docstring.NumpyDocstring._parse_see_also_section
Method - napoleon.docstring.Token.__init__
Instance Variable - napoleon.docstring.Token.type
Instance Variable - napoleon.docstring.Token.value
Class - napoleon.docstring.TokenType
Constant - napoleon.docstring.TokenType.ANY
Constant - napoleon.docstring.TokenType.CONTROL
Constant - napoleon.docstring.TokenType.DELIMITER
Constant - napoleon.docstring.TokenType.LITERAL
Constant - napoleon.docstring.TokenType.OBJ
Constant - napoleon.docstring.TokenType.REFERENCE
Constant - napoleon.docstring.TokenType.UNKNOWN
Method - napoleon.docstring.Tokenizer.__init__
Class Method - napoleon.docstring.Tokenizer.build
Method - napoleon.docstring.TypeDocstring.__init__
Class Variable - napoleon.docstring.TypeDocstring._ast_like_delimiters_regex
Class Variable - napoleon.docstring.TypeDocstring._ast_like_delimiters_regex_str
Static Method - napoleon.docstring.TypeDocstring._convert_type_spec_to_rst
Class Variable - napoleon.docstring.TypeDocstring._default_regex
Class Variable - napoleon.docstring.TypeDocstring._natural_language_delimiters_regex
Class Variable - napoleon.docstring.TypeDocstring._natural_language_delimiters_regex_str
Class Variable - napoleon.docstring.TypeDocstring._token_regex
Instance Variable - napoleon.docstring.TypeDocstring._tokens
Instance Variable - napoleon.docstring.TypeDocstring.warnings
Type Variable - napoleon.docstring._T
Variable - napoleon.docstring._bullet_list_regex
Variable - napoleon.docstring._directive_regex
Variable - napoleon.docstring._enumerated_list_regex
Variable - napoleon.docstring._google_section_regex
Variable - napoleon.docstring._google_typed_arg_regex
Variable - napoleon.docstring._numpy_section_regex
Variable - napoleon.docstring._single_colon_regex
Variable - napoleon.docstring._xref_or_code_regex
Variable - napoleon.docstring._xref_regex
Type Variable - napoleon.iterators.T
Instance Variable - napoleon.iterators.modify_iter.modifier
Method - napoleon.iterators.peek_iter.__iter__
Method - napoleon.iterators.peek_iter.__next__
Instance Variable - napoleon.iterators.peek_iter._cache
Instance Variable - napoleon.iterators.peek_iter._iterable
Instance Variable - napoleon.iterators.peek_iter.counter
Instance Variable - napoleon.iterators.peek_iter.sentinel
Method - numpy_demo.ExampleClass.__special_without_docstring__
Method - numpy_demo.ExampleClass._private_without_docstring
Instance Variable - numpy_demo.ExampleClass.attr1
Instance Variable - numpy_demo.ExampleClass.attr2
Method - numpy_demo.ExampleClass.readwrite_property.setter
Method - numpy_demo.ExampleError.__init__
Instance Variable - numpy_demo.ExampleError.code
Instance Variable - numpy_demo.ExampleError.msg
Variable - numpy_demo.module_level_variable1