update docs (#578)

* update docs

* update docs
This commit is contained in:
Atsushi Sakai
2021-11-26 21:46:14 +09:00
committed by GitHub
parent 094a413dcd
commit 9d759d13c6
4 changed files with 44 additions and 12 deletions

View File

@@ -1,11 +1,7 @@
<!--
Thanks for contributing a pull request!
Please ensure that your PR satisfies the checklist before submitting:
- [] This project only accept codes for python 3.9 or higher.
- [] If you add a new algorithm sample code, please add a unit test file under `test` dir.
This sample test code might help you : https://github.com/AtsushiSakai/PythonRobotics/blob/master/tests/test_a_star.py
- [] If you fix a bug of existing code please add a test function in the test code to show the issue was solved.
- [] Please fix all issues on CI (All CI should be green), before code review.
Please check this document before submitting:
- [How to contribute](https://pythonrobotics.readthedocs.io/en/latest/how_to_contribute.html#adding-a-new-algorithm-example)
Note that this is my hobby project; I appreciate your
patience during the review process.
@@ -21,3 +17,8 @@ Again, thanks for contributing!
#### Additional information
<!--Any additional information you think is important.-->
#### CheckList
-[] Did you add an unittest for your new example or defect fix?
-[] Did you add documents for your new example?
-[] All CIs are green? (You can check it after submitting)