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

Completely lacking documentation on moveit servo #3243

Open
PietroValerio opened this issue Jan 13, 2025 · 1 comment
Open

Completely lacking documentation on moveit servo #3243

PietroValerio opened this issue Jan 13, 2025 · 1 comment
Labels
documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@PietroValerio
Copy link

Description

Completely lacking documentation, cpp api assumes that the controller used accepts messages of type trajectory_msgs::msg::joint_trajectory, what about if we have a controller only accepting std_msgs/msg/Float64MultiArray. Nothing inside the documentation covering this use case, you need to go digging inside the codebase to find that there is a function composeMultiArrayMessage that maybe can do the job, but you can't know it because is not documented.
You want to be the industry de-facto standard, before you should worry about fixing your documentation

ROS Distro

Jazzy

OS and version

24.04

Source or binary build?

Source

If binary, which release version?

No response

If source, which branch?

main

Which RMW are you using?

None

Steps to Reproduce

Watch moveit servo tutorial

Expected behavior

Fully documented

Actual behavior

Lacking documentation

Backtrace or Console output

No response

@PietroValerio PietroValerio added the bug Something isn't working label Jan 13, 2025
@mikeferguson
Copy link
Contributor

This is an open source project, staffed by volunteers. PRs to improve documentation are welcome.

@sea-bass sea-bass added help wanted Extra attention is needed good first issue Good for newcomers documentation and removed bug Something isn't working labels Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants