This is a module demonstrating epydoc code documentation features.
Most part of this documentation is using Python type hinting.
Interface |
|
Example of an interface with schemas. |
Class |
|
This is the docstring of this class. |
Function | demo |
The inline markup construct L{text<object>} is used to create links to the documentation for other Python objects. 'text' is the text that should be displayed for the link, and 'object' is the name of the Python object that should be linked to. |
Function | demo |
Fields are used to describe specific properties of a documented object. |
Function | demo |
Long names and annotations should display on several lines when they don't fit in a single line. |
Function | demo |
Overload signatures appear without the main signature and with @overload decorator. |
Function | demo |
Undocumented |
Function | demo |
Type documentation can be extracted from standard Python type hints. |
Function | demo |
Undocumented |
Constant | LANG |
This is a constant. See constants for more examples. |
Constant | lang |
This is also a constant, but annotated with typing.Final. |
Type Alias |
|
Type aliases are documented as such and their value is shown just like constants. |
Class | _ |
This is the docstring of a private class. |
The inline markup construct L{text<object>} is used to create links to the documentation for other Python objects. 'text' is the text that should be displayed for the link, and 'object' is the name of the Python object that should be linked to.
If you wish to use the name of the Python object as the text for the link, you can simply write L{object}.
Fields are used to describe specific properties of a documented object.
This function can be used in conjunction with demo_typing_arguments
to find an arbitrary function's zeros.
Parameters | |
m:number | The slope of the line. |
b:number | The y intercept of the line. |
Returns | |
number | the x intercept of the line y = m*x + b. |
str
, what__another_super_super_long_name__ho_no: Generator[ Union[ List[ AnyStr], Dict[ str, AnyStr]], None, None]
) -> bool
:
(source)
¶
Long names and annotations should display on several lines when they don't fit in a single line.
math.prod
instead.Undocumented