diff options
Diffstat (limited to 'CONTRIBUTING.rst')
| -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): |