added hierarchy rules
This commit is contained in:
@@ -208,6 +208,31 @@ class Class
|
||||
|
||||
# Writing Rules
|
||||
|
||||
**Heading hierarchy**
|
||||
|
||||
Module docstring
|
||||
|
||||
- Examples
|
||||
- Usage
|
||||
- Core concepts
|
||||
- Public API
|
||||
|
||||
Class docstring
|
||||
|
||||
- Attributes
|
||||
- Execution contract
|
||||
- Lifecycle
|
||||
- Thread safety
|
||||
- Notes
|
||||
|
||||
Method docstring
|
||||
|
||||
- Parameters
|
||||
- Returns
|
||||
- Raises
|
||||
- Yields
|
||||
- Behavior
|
||||
|
||||
**Required**
|
||||
|
||||
* Use Markdown headings
|
||||
|
||||
Reference in New Issue
Block a user