PEP 257

GPTKB entity

Statements (48)
Predicate Object
gptkbp:instance_of gptkb:Library
gptkbp:applies_to gptkb:language
gptkbp:author gptkb:Guido_van_Rossum
gptkbp:contains guidelines for module, class, and function docstrings
gptkbp:created 2001-11-01
gptkbp:created_by gptkb:Guido_van_Rossum
gptkbp:defines gptkb:Docstring_format
gptkbp:encourages consistent documentation style
Consistency in docstring style
gptkbp:first_published 2001-11-01
2018-01-01
https://www.w3.org/2000/01/rdf-schema#label PEP 257
gptkbp:includes Examples of docstring formats
gptkbp:influences Python community practices
gptkbp:is_adopted_by gptkb:Python_Software_Foundation
gptkbp:is_cited_in PEP 2570
Python style guides
gptkbp:is_described_as conventions for writing docstrings in Python
gptkbp:is_discussed_in Python mailing lists
gptkbp:is_implemented_in Python 2.0 and later
gptkbp:is_part_of gptkb:Python_Enhancement_Proposals
Python documentation
gptkbp:is_referenced_in gptkb:PEP_484
gptkb:PEP_8
gptkbp:is_related_to PEP 8 (style guide)
Documentation best practices
gptkbp:is_reviewed_by gptkb:Library
gptkbp:is_supported_by ID Es and linters
gptkbp:is_used_by Python developers
gptkbp:latest_version gptkb:PEP_257.1
gptkbp:provides examples of docstrings
docstring conventions for Python
gptkbp:provides_information_on Class docstrings
Function docstrings
Module docstrings
gptkbp:purpose Provide conventions for writing docstrings
gptkbp:related_to gptkb:PEP_8
gptkbp:replaced_by PEP 8 (section on docstrings)
PEP 8 section on docstrings
gptkbp:specifies the format of docstrings
Triple quotes for docstrings
gptkbp:status gptkb:Final
gptkbp:suitable_for One-liner summary for docstrings
Use of imperative mood in docstrings
gptkbp:title Docstring Conventions
Docstring conventions
gptkbp:bfsParent gptkb:PEP_8
gptkbp:bfsLayer 5