example_google module

Example Google style docstrings.

This module demonstrates documentation as specified by the Google Python Style Guide. Docstrings may extend over multiple lines. Sections are created with a section header and a colon followed by a block of indented text.

Example

Examples can be given using either the Example or Examples sections. Sections support any reStructuredText formatting, including literal blocks:

$ python example_google.py

Section breaks are created by simply resuming unindented text. Section breaks are also implicitly created anytime a new section starts.

example_google.module_level_variable

int

Module level variables may be documented in either the Attributes section of the module docstring, or in an inline docstring immediately following the variable.

Either form is acceptable, but the two should not be mixed. Choose one convention to document module level variables and be consistent with it.

example_google.module_level_function(param1, param2=None, *args, **kwargs)

This is an example of a module level function.

Function parameters should be documented in the Args section. The name of each parameter is required. The type and description of each parameter is optional, but should be included if not obvious.

If the parameter itself is optional, it should be noted by adding ”, optional” to the type. If *args or **kwargs are accepted, they should be listed as *args and **kwargs.

The format for a parameter is:

name (type): description
  The description may span multiple lines. Following
  lines should be indented.

  Multiple paragraphs are supported in parameter
  descriptions.
Parameters:
  • param1 (int) – The first parameter.
  • param2 (str, optional) – The second parameter. Defaults to None. Second line of description should be indented.
  • *args – Variable length argument list.
  • **kwargs – Arbitrary keyword arguments.
Returns:

True if successful, False otherwise.

The return type is optional and may be specified at the beginning of the Returns section followed by a colon.

The Returns section may span multiple lines and paragraphs. Following lines should be indented to match the first line.

The Returns section supports any reStructuredText formatting, including literal blocks:

{
    'param1': param1,
    'param2': param2
}

Return type:

bool
Raises:
  • AttributeError – The Raises section is a list of all exceptions that are relevant to the interface.
  • ValueError – If param2 is equal to param1.
example_google.example_generator(n)

Generators have a Yields section instead of a Returns section.

Parameters:n (int) – The upper limit of the range to generate, from 0 to n - 1
Yields:int – The next number in the range of 0 to n - 1

Examples

Examples should be written in doctest format, and should illustrate how to use the function.

>>> print [i for i in example_generator(4)]
[0, 1, 2, 3]
exception example_google.ExampleError(msg, code=2)

Bases: exceptions.Exception

Exceptions are documented in the same way as classes.

The __init__ method may be documented in either the class level docstring, or as a docstring on the __init__ method itself.

Either form is acceptable, but the two should not be mixed. Choose one convention to document the __init__ method and be consistent with it.

Note

Do not include the self parameter in the Args section.

Parameters:
  • msg (str) – Human readable string describing the exception.
  • code (int, optional) – Error code, defaults to 2.
msg

str

Human readable string describing the exception.

code

int

Exception error code.

class example_google.ExampleClass(param1, param2, param3=0)

Bases: object

The summary line for a class docstring should fit on one line.

If the class has public attributes, they should be documented here in an Attributes section and follow the same formatting as a function’s Args section.

attr1

str

Description of attr1.

attr2

list of str

Description of attr2.

attr3

int

Description of attr3.

example_method(param1, param2)

Class methods are similar to regular functions.

Note

Do not include the self parameter in the Args section.

Parameters:
  • param1 – The first parameter.
  • param2 – The second parameter.
Returns:

True if successful, False otherwise.
__special__()

By default special members with docstrings are included.

Special members are any methods or attributes that start with and end with a double underscore. Any special member with a docstring will be included in the output.

This behavior can be disabled by changing the following setting in Sphinx’s conf.py:

napoleon_include_special_with_doc = False