what's docstrung

2026-06-05 22:50:18 +00:00 · 2016-02-19 04:56:25 -05:00
parent 8dc5f68bc1
commit 1cf1699e37
1 changed files with 3 additions and 0 deletions
@@ -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/