Connor wool/update localization code documentation#404
Conversation
|
Obligatory #404: Pull Request Not Found |
|
In general, your comments are far too in depth. There is no need to document every individual line of code and how ROS calls work. You have documented this as if it were a ROS tutorial which is unnecessary. Reviewed 4 of 4 files at r1. src/localization/localization.cpp, line 9 at r1 (raw file):
This kind of documentation is unnecessary. Tutorial-like documentation on ROS is better suited in examples so that these files are not bloated. Assume that anyone reading this has a basic understanding of ROS. For many of the following comments, simply note what each section of code is doing, not exactly how it works. src/localization/localization.cpp, line 37 at r1 (raw file):
You are defining what a C++ constructor is here. This is better worded as: Be brief with comments in source files. You can elaborate further if absolutely necessary on the wiki. Comments from Reviewable |
Adds clarifying comments to code in the localization system. I had to go through and read a bunch of ROS documentation to figure out what's going on, and why certain things are included. Hopefully, by adding these comments, nobody has to do that ever again ;_;
This change is