Added a lot more documentation to each of the sections in the kart launch file, hector_navigation.launch, based on the current understanding of the system.
Is this fixing an issue?
No
Are there more details that are relevant?
This added documentation is likely temporary and will be moved over to external documentation like the AMP v1 design doc. But for now, keeping it here makes sense as it will likely be updating alongside the proceeding launch file PRs with newly uncovered knowledge and changes to the system.
In addition to the main changes in hector_navigation.launch, there were a few changes in other files:
move_base.launch: A TODO on what needs to be added in terms of documentation in this file moving forward (mirroring the type of documentation in hector_navigation.launch).
sim_autocross_track.launch: Small comment changes.
laser_scan_matcher_params.yaml: Added a note on findings from discovering REP 105 from this ROS post. Also corrected datatypes of some parameters to start playing around with this param file to see its effects on the rqt_graph for hector_navigation.launch.
Check lists (check x in [ ] of list items)
[ ] Test written/updating
[ ] Tests passing
[x] Coding style (indentation, etc)
No testing needed for launch file development.
Any additional comments?
As compared to PR #1 this is a much better example of a good PR as it is:
Small (number of lines changes). Try to keep most PRs under ~200 lines of changes if possible, but the smaller the better.
What is a quick description of the change?
Added a lot more documentation to each of the sections in the kart launch file,
hector_navigation.launch, based on the current understanding of the system.Is this fixing an issue?
No
Are there more details that are relevant?
This added documentation is likely temporary and will be moved over to external documentation like the AMP v1 design doc. But for now, keeping it here makes sense as it will likely be updating alongside the proceeding launch file PRs with newly uncovered knowledge and changes to the system.
In addition to the main changes in hector_navigation.launch, there were a few changes in other files:
move_base.launch: A TODO on what needs to be added in terms of documentation in this file moving forward (mirroring the type of documentation inhector_navigation.launch).sim_autocross_track.launch: Small comment changes.laser_scan_matcher_params.yaml: Added a note on findings from discovering REP 105 from this ROS post. Also corrected datatypes of some parameters to start playing around with this param file to see its effects on the rqt_graph forhector_navigation.launch.Check lists (check x in [ ] of list items)
No testing needed for launch file development.
Any additional comments?
As compared to PR #1 this is a much better example of a good PR as it is: