diff options
| author | Kenneth Reitz <me@kennethreitz.org> | 2016-02-19 04:56:25 -0500 |
|---|---|---|
| committer | Kenneth Reitz <me@kennethreitz.org> | 2016-02-19 04:56:25 -0500 |
| commit | 1cf1699e37139daa37913e989c91fa130a2472fe (patch) | |
| tree | 9649424576dd2c5059bb19bce702b31c252233d6 /docs/dev | |
| parent | 8dc5f68bc1d9d28b79478f495be445ba048e8081 (diff) | |
| download | python-requests-1cf1699e37139daa37913e989c91fa130a2472fe.tar.gz | |
what's docstrung
Diffstat (limited to 'docs/dev')
| -rw-r--r-- | docs/dev/contributing.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/dev/contributing.rst b/docs/dev/contributing.rst index feb7e741..41159fb9 100644 --- a/docs/dev/contributing.rst +++ b/docs/dev/contributing.rst @@ -142,6 +142,9 @@ Docstrings are to follow the following syntaxes:: nisi ut aliquip ex ea commodo consequat. """ +All functions, methods, and classes are to contain docstrings. Object data +model methods (e.g. ``__repr__``) are usually an exception to this rule. + Thanks for helping to make the world a better place! .. _PEP8: https://www.python.org/dev/peps/pep-0008/ |