Statements (97)
| Predicate | Object |
|---|---|
| gptkbp:instance_of |
gptkb:Library
gptkb:museum |
| gptkbp:advises |
using a blank line after the summary line in docstrings
to include a more detailed description after the summary |
| gptkbp:aims_to |
Improve code readability
Encourage consistency |
| gptkbp:approves |
gptkb:Python_Steering_Council
|
| gptkbp:author |
gptkb:Guido_van_Rossum
|
| gptkbp:base |
docstrings should be consistent with the code style
|
| gptkbp:contains |
guidelines for writing docstrings
section on docstrings |
| gptkbp:covered_by |
Comments
Whitespace Naming conventions comments naming conventions indentation Indentation whitespace Code layout Programming recommendations line length code layout programming recommendations |
| gptkbp:created |
2001-07-19
|
| gptkbp:created_by |
gptkb:2001
|
| gptkbp:emphasizes |
the importance of documenting public AP Is
|
| gptkbp:encourages |
consistency
readability consistent formatting of docstrings using imperative mood in docstrings |
| gptkbp:first_published |
January 2021
July 2001 |
| https://www.w3.org/2000/01/rdf-schema#label |
PEP 8
|
| gptkbp:includes |
naming conventions
|
| gptkbp:is_adopted_by |
gptkb:Python_Software_Foundation
|
| gptkbp:is_available_on |
https://www.python.org/dev/peps/pep-0008/
|
| gptkbp:is_described_as |
Style Guide for Python Code
coding style guidelines for Python style guide for Python code Python coding conventions coding style guidelines |
| gptkbp:is_essential_for |
Python code quality
|
| gptkbp:is_maintained_by |
gptkb:David_Beazley
gptkb:Guido_van_Rossum gptkb:Brett_Cannon gptkb:Raymond_Hettinger gptkb:Van_Lindberg gptkb:Python_Software_Foundation gptkb:Paul_Moore gptkb:Travis_Olliphant gptkb:Library gptkb:Andrew_Svetlov gptkb:Chris_Angelico gptkb:Ethan_Furman gptkb:Jesse_Noller gptkb:Mark_Shannon gptkb:Michael_Foord gptkb:Nick_Coghlan gptkb:Steve_Dower gptkb:Terry_Reedy gptkb:Barry_Warsaw |
| gptkbp:is_often_used_in |
gptkb:Library
Python developers |
| gptkbp:is_part_of |
gptkb:Python_Enhancement_Proposals
gptkb:Library Python's official documentation |
| gptkbp:is_referenced_in |
gptkb:PEP_20
gptkb:PEP_257 other PE Ps |
| gptkbp:is_reflected_in |
changes in Python language and community practices
|
| gptkbp:is_related_to |
gptkb:PEP_484
gptkb:PEP_572 Python coding standards |
| gptkbp:is_used_in |
gptkb:language
Python projects |
| gptkbp:latest_version |
8.0
|
| gptkbp:provides |
style guidelines for Python code
examples of good docstrings guidelines for formatting docstrings |
| gptkbp:published_by |
gptkb:Guido_van_Rossum
gptkb:Python_Software_Foundation July 2001 |
| gptkbp:related_to |
Python developers
|
| gptkbp:replaced_by |
gptkb:PEP_257
|
| gptkbp:state |
docstrings should describe the method's effect as a command
docstrings should be used to describe modules, classes, methods, and functions |
| gptkbp:status |
gptkb:Final
|
| gptkbp:suitable_for |
consistent indentation
including a summary line in docstrings using triple quotes for docstrings including parameters and return types in function docstrings the first line of a docstring should be a short summary |
| gptkbp:title |
Style Guide for Python Code
|
| gptkbp:updates |
gptkb:Barry_Warsaw
|
| gptkbp:bfsParent |
gptkb:PEP_3333
|
| gptkbp:bfsLayer |
4
|