Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting CLI tools? #550

Open
zflat opened this issue Aug 11, 2022 · 3 comments
Open

Documenting CLI tools? #550

zflat opened this issue Aug 11, 2022 · 3 comments
Labels

Comments

@zflat
Copy link

zflat commented Aug 11, 2022

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.

@clalancette
Copy link
Contributor

Agreed that that would be the correct place. Right now, there is no documentation like that, but we'd be happy to review pull requests adding it.

@CursedRock17
Copy link
Contributor

I would like to pick this up if possible, but to have a more centralized documentation, should we create a https://docs.ros.org/en/humble/p/geometry2/ ? Then, we can take our examples and put them underneath an examples section within the tf2_ros section of the documentation.

@clalancette
Copy link
Contributor

I would like to pick this up if possible, but to have a more centralized documentation, should we create a https://docs.ros.org/en/humble/p/geometry2/ ? Then, we can take our examples and put them underneath an examples section within the tf2_ros section of the documentation.

So the way that this works is that the documentation is auto-generated by the buildfarm. But it is uploaded on a per-package, not a per-repository basis. Thus we already have the correct directory: http://docs.ros.org/en/humble/p/tf2_ros/ .

That said, our usual practice is to make changes to rolling, and then backport as needed. So I'll suggest starting there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants