API reference¶

example_google¶

`example_google.function_with_types_in_docstring`(…)	Example function with types documented in the docstring.
`example_google.module_level_function`(param1)	This is an example of a module level function.
`example_google.example_generator`(n)	Generators have a `Yields` section instead of a `Returns` section.
`example_google.ExampleError`(msg, code)	Exceptions are documented in the same way as classes.
`example_google.ExampleClass`(param1, param2, …)	The summary line for a class docstring should fit on one line.
`example_google.ExampleClass.readonly_property`	str – Properties should be documented in their getter method.
`example_google.ExampleClass.readwrite_property`	list(str) – Properties with both a getter and setter
`example_google.ExampleClass.readwrite_property`	list(str) – Properties with both a getter and setter
`example_google.ExampleClass.example_method`(…)	Class methods are similar to regular functions.

`example_numpy.function_with_types_in_docstring`(…)	Example function with types documented in the docstring.
`example_numpy.module_level_function`(param1)	This is an example of a module level function.
`example_numpy.example_generator`(n)	Generators have a `Yields` section instead of a `Returns` section.
`example_numpy.ExampleError`(msg, code)	Exceptions are documented in the same way as classes.
`example_numpy.ExampleClass`(param1, param2, …)	The summary line for a class docstring should fit on one line.
`example_numpy.ExampleClass.readonly_property`	str – Properties should be documented in their getter method.
`example_numpy.ExampleClass.readwrite_property`	list(str) – Properties with both a getter and setter
`example_numpy.ExampleClass.readwrite_property`	list(str) – Properties with both a getter and setter
`example_numpy.ExampleClass.example_method`(…)	Class methods are similar to regular functions.