Improve documentation of nav_msgs/SetMap.srv
Open
Nobody has claimed this yet.
documentation
- Dominant language
- C++
- Stars
- 393
- Forks
- 157
- PR merge metrics
- No merged PRs in 30d
Description
This is a follwup to the pre Foxy Message API review
Any reason in particular for the service this includes the extra initial_pose field? (in comparison to the getMap.srv that only returns a map)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with nav_msgs/SetMap.srv and compare it with getMap.srv. Read the linked pre-Foxy Message API review, especially the question about initial_pose, to determine what documentation is missing. Done means the service’s extra initial_pose field and its relationship to getMap.srv are clearly documented.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100