diff --git a/doc/contributing.rst b/doc/contributing.rst index deac0bad476192bfb3b04555ac786895bb6192d1..c4ba7c73478aee3dbd85fa8a2bb3dec1036b1a79 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -7,7 +7,9 @@ advice would be to use existing bits and pieces as examples and to be consistent with what you already find here. As an example, documentation explaining what a whole module is supposed to do usually goes into a :file:`doc` directory within the modules tree, while the API itself is -documented inline. +documented inline. One exception exists on the example-driven approach: +following the :mod:`~promod3.core` module for your setup is not advisable. This +one is a bit special and provides core functionality to everybody else. -------------------------------------------------------------------------------- |git| Branches @@ -221,4 +223,4 @@ the Changelog. It will be automatically pulled into the documentation. .. LocalWords: cmake hotfix doctest linkcheck rebase BRANCHNAME rebasing py .. LocalWords: CMakeLists txt rst pymod init submodule src restructuredtext -.. LocalWords: makefiles formatters Changelog codetest +.. LocalWords: makefiles formatters Changelog codetest promod