ros2_documentation
ros2_documentation copied to clipboard
Unclear sections
Reading through the ROS 2 documentation, the following sections were unclear to me.
Concepts/About-Composition.html
- "ROS 2 - Unified API" - "This makes it easy to add common concepts to existing code, like a life cycle" I don't understand what this is trying to say. Perhaps "This makes it easy to combine (and recombine) nodes into different processes." IMO, it's about the deployment of nodes. Nodes might be combined into the same process for performance reasons, for example.
Installation.html
- "...which shares installation instructions with the Rolling distribution." - Why is this important to know? I'm not clear on the reason this was mentioned. Could probably be deleted.
Guides/Developing-a-ROS-2-Package.html
- " "Python packages" - "and a setup.py file that looks like:" Does this mean that this is the recommended set of items to specify? The minimum set?
Guides/Ament-CMake-Documentation.html
- "Adding Dependencies" - "The recommended way in modern CMake..." - This section started off by saying that there are two wasy to link your packages against a new dependency. It lists the first and then the second ways. Then, it mentions, in a separate paragraph, "The recommended way in modern cmake..." I'm not clear which way (or both) this is referring to. Is it an elaboration on the second way? Or, is does it refer to both of the previously mentioned ways?
Installation/Ubuntu-Install-Binary.html
- Regarding the "Note" section - I'm wondering about the logic of what is included in the pre-built binary. The note mentions a subset of packages, but I don't understand how that subset was included.
Guides/Installation-Troubleshooting.html
- "Import failing without library present on the system" section - "...comparing the libraries present in the directory with the one mentioned in the error message." Which directory is this referring to? The cwd? I don't think these instructions are clear. I suggest these two paragraphs be rewritten.
Contact.html
- "Issues" - "example search query" It's not clear to me how to leverage this seach query for making my own queries.