diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-10-09 18:39:24 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-10-09 18:39:24 +0900 |
| commit | 885bd9466eaf40097005a5e1c54f1a9984be5984 (patch) | |
| tree | c102ded8c87da811b3aefc593d3f06b65a45a2d2 | |
| parent | ac0776f8b13885119127d4cce73327bcd07fec22 (diff) | |
| download | buildstream-885bd9466eaf40097005a5e1c54f1a9984be5984.tar.gz | |
CONTRIBUTING.rst: Added note about sphinx supporting docstrings on instance variables
Python does not natively support this, but sphinx does parse them and includes
these in the generated documentation.
| -rw-r--r-- | CONTRIBUTING.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bf10950ea..781cd58ea 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -270,6 +270,11 @@ comments and docstrings. *Since: 1.2* """ +.. note:: + + Python does not really support docstrings on instance variables, but + sphinx does pick them up includes them in the generated documentation. + **Internal instance variable**:: def __init__(self, context, element): |