Skip to content

Commit 88671e4

Browse files
authored
add doc policy (AtsushiSakai#609)
1 parent 7034d5f commit 88671e4

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/how_to_contribute_main.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,10 @@ Please check other documents for details.
6565

6666
You can build the doc locally based on `doc README`_.
6767

68+
Note that the `reStructuredText`_ based doc should only focus on the mathematics and the algorithm of the example.
69+
70+
Documentations related codes should be in the python script as the header comments of the script or docstrings of each function.
71+
6872

6973
.. _`submit a pull request`:
7074

0 commit comments

Comments
 (0)