Setting up Turtlesim - how-to#6935
Conversation
Change from tutorial to how-to and update accordingly.
…or-openrobotics/ros2_documentation into setting-up-turtlesim-howto
fujitatomoya
left a comment
fujitatomoya
left a comment
There was a problem hiding this comment.
overall lgtm, just one comment to check.
| @@ -4,50 +4,49 @@ | |||
|
|
|||
| .. _Turtlesim: | |||
|
|
|||
| Using ``turtlesim``, ``ros2``, and ``rqt`` | |||
| ========================================== | |||
| Setting up Turtlesim - how-to | |||
There was a problem hiding this comment.
I thought turtlesim lowercases are the correct one?
There was a problem hiding this comment.
@fujitatomoya My initial thinking was Turtlesim when referring to the product name in general and turtlesim when referring to the package / anything in the CLI context – and so this is how I've been consistently using it. So I would say, for example, "Setting up Turtlesim" but "using turtlesim".
Should we always use lowercase instead?
Technically, proper nouns shouldn't dictate grammar, no matter how the product names are stylized, but I see no issue either way as long as it's consistent. But then there is also TurtleSim.
Please advise what OR would like to see best, and I'll use it throughout.
| $ ros2 node list | ||
| $ ros2 topic list | ||
| $ ros2 service list | ||
| $ ros2 action list |
There was a problem hiding this comment.
I know we're simply following an old tutorial here but this is rather unsatisfying. We should provide some context about what these commands are showing the user and why they should care.
|
|
||
| 6 Remapping | ||
| ^^^^^^^^^^^ | ||
| #. In a new terminal, control ``turtle2`` by remapping: |
There was a problem hiding this comment.
Like I said, I know we're simply following the previous material but this is really unsatisfying. There's no definition of what we mean by remapping or why we would have to do that to control a second turtle. If we're going to update this page we should aim for it to more informative than it was before.
There was a problem hiding this comment.
@kscottz Thanks! That was indeed too sparse and vague, I should have noticed. Fixed now, hopefully – let me know.
4 participants
Updated the article "Introducing Turtlesim" as approved by Geoff and Tully.
Description
Related to: ros2/ros2#1725
Did you use Generative AI?
Yes, for the FAQ section.
Additional Information
Documentation updates from 3di Information Solutions, agreed with Geoff and Tully.
Label
Please add backport-lyrical.