Skip to content
Snippets Groups Projects
Commit ac4145f8 authored by Bienchen's avatar Bienchen
Browse files

Hint to not use core as example

parent 0ff56097
No related branches found
No related tags found
No related merge requests found
...@@ -7,7 +7,9 @@ advice would be to use existing bits and pieces as examples and to be ...@@ -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 consistent with what you already find here. As an example, documentation
explaining what a whole module is supposed to do usually goes into a 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 :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 |git| Branches
...@@ -221,4 +223,4 @@ the Changelog. It will be automatically pulled into the documentation. ...@@ -221,4 +223,4 @@ the Changelog. It will be automatically pulled into the documentation.
.. LocalWords: cmake hotfix doctest linkcheck rebase BRANCHNAME rebasing py .. LocalWords: cmake hotfix doctest linkcheck rebase BRANCHNAME rebasing py
.. LocalWords: CMakeLists txt rst pymod init submodule src restructuredtext .. LocalWords: CMakeLists txt rst pymod init submodule src restructuredtext
.. LocalWords: makefiles formatters Changelog codetest .. LocalWords: makefiles formatters Changelog codetest promod
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment