Details
-
Type:
Improvement
-
Status: To Do
-
Resolution: Unresolved
-
Fix Version/s: None
-
Component/s: Developer Infrastructure
-
Labels:
-
Epic Link:
-
Team:SQuaRE
Description
The guidelines for documenting function parameters in Python give examples showing the parameter name, followed by a space, a colon, a space, and a text string describing the type. However, the guidelines do not say that this whitespace is significant: if the parameter name is immediately followed by a colon, the type description will be printed verbatim (with, for example, explicit ` marks).
Please update the guide to specifically say that the parameter name and the colon must be separated by a space.
Attachments
Issue Links
- relates to
-
DM-12951 Improve Numpydoc documentation in Developer Guide
- Done