NxRLab / ModernRobotics

Modern Robotics: Mechanics, Planning, and Control Code Library --- The primary purpose of the provided software is to be easy to read and educational, reinforcing the concepts in the book. The code is optimized neither for efficiency nor robustness.
http://modernrobotics.org/
MIT License
1.9k stars 807 forks source link

Formatting issues in Python library docstrings #8

Closed jarvisschultz closed 5 years ago

jarvisschultz commented 5 years ago

There are a variety of formatting issues in the docstrings in the Python library. While this isn't a huge deal, it does mean that some of the example usage cannot be directly copy-pasted into a Python interpreter and have it run successfully. This is true even with an indention-aware, "smart" interpreter like IPython's %paste function. Here are a few issues that I noticed:

zrwang commented 5 years ago

I should look into your pull request before creating one. I found some similar problems mentioned in this issue. I also fixed wrong indentations, especially in the function description comments. Anyway, thanks for your effort.

jarvisschultz commented 5 years ago

@zrwang thanks for your attention to detail!

@HuanWeng can you please review both of these PRs, and accept whichever is more appropriate and then close the other?

jarvisschultz commented 5 years ago

Now that #9 is merged, we can close this issue.