ros2 / ros2/geometry2

Documenting CLI tools?

Open
#550 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

backlog
Dominant language
C++
Stars
153
Forks
256
Avg merge
3d 23h
Merged PRs (30d)
14

Description

Is there any documentation of tf_echo and other tools that can be run from the command line that is equivalent to http://wiki.ros.org/tf/Debugging%20tools and http://wiki.ros.org/tf2_ros#Tools ?

I think that http://docs.ros.org/en/humble/p/tf2_ros/ would be the correct place for such documentation.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing tf2_ros documentation at http://docs.ros.org/en/humble/p/tf2_ros/ and compare it with the linked tf debugging-tools documentation. Identify which command-line tools, including tf_echo, need coverage. Done means the relevant tools have equivalent documentation in the tf2_ros documentation location.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.