review sensor_msgs/Image for clarity on step and row documentation
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
In a comment is said that full size of data array is step*rows. But there is already rows and columns defined as height and width, not sure if there could either a little mistake in the comment description or a extra variable on the usage
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 the sensor_msgs/Image message definition and the pre-Foxy Message API review linked in the issue; compare the wording for step, height, width, rows, and the data array. Done means the relationship between step and the array size is documented unambiguously in the message definition.
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
- 35/100