github/PythonRobotics
1
1
Fork 0
mirror of https://github.com/AtsushiSakai/PythonRobotics.git synced 2026-04-22 03:00:22 -04:00
Code Issues Packages Projects Releases Wiki Activity

add doc policy (#609)

Browse Source
This commit is contained in:
Atsushi Sakai
2021-12-26 10:55:21 +09:00
committed by GitHub
parent 7034d5ff9e
commit 88671e4ba1
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/how_to_contribute_main.rst
View File

@@ -65,6 +65,10 @@ Please check other documents for details.
You can build the doc locally based on `doc README`_.
Note that the `reStructuredText`_ based doc should only focus on the mathematics and the algorithm of the example.
Documentations related codes should be in the python script as the header comments of the script or docstrings of each function.
.. _`submit a pull request`: