-
Notifications
You must be signed in to change notification settings - Fork 0
Docstring Template
Vinicius Reif Biavatti edited this page Jul 25, 2022
·
5 revisions
- Remove the content that will not be used
- Try to always follow this template to keep the same organization
"""
Summary of the resource here.
Properties:
name: Class property description here
Abstract Methods:
build: Summary for build abstract method
Args:
value: Positional argument description with some information and with
break line for multi-line description.
*values: Arbitrary argument description.
**kwvalue: Keyword argument description.
Returns:
Return type description.
Yields:
Return type description used when the function is a generator.
Raises:
IOError: Error description and some information.
Examples:
Sum two integer or float numbers and returns the result
add(1, 3) -> 4
See Also:
math.pi: Example of module constant documentation.
Notes:
Some notes here.
Authors:
John Due: [email protected]
References:
Python website: https://www.python.org/
Tests:
Sum two integer or float numbers and returns the result
>>> add(1, 3)
4
"""
- Home
- Structural Naming Conventions
- Format Conventions
- Code Naming Conventions
- Inheritance
- Access Modifiers
- Importation
- Functions and Methods
- Documentation
- Resources