Instruct developers how to document code.

glotzerlab · Nov 26, 2024 · 5ae6b2d · 5ae6b2d
1 parent 9c5aa8e
commit 5ae6b2d
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -88,7 +88,9 @@ User documentation
 Write user documentation
 ________________________
 
-Document public-facing API with Python docstrings in Google style.
+Document public-facing API with Python docstrings in Google style, use the ``_doc_inherited``
+member as documented in ``ARCHITECTURE.md`` and list new public classes and functions in
+``__all__``.
 
 Add developer to the credits
 ____________________________