From 1cf1699e37139daa37913e989c91fa130a2472fe Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Fri, 19 Feb 2016 04:56:25 -0500 Subject: [PATCH] what's docstrung --- docs/dev/contributing.rst | 3 +++ 1 file changed, 3 insertions(+) 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/