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

Fix u16 docs and improve docs formatting #805

Merged
merged 3 commits into from
Apr 26, 2024

Conversation

christophebedard
Copy link
Member

@christophebedard christophebedard commented Apr 26, 2024

  1. I noticed that the docs for the size param for the u16 string sequence functions in rosidl_runtime_c are wrong. The size param refers to the size of the sequence, not the string. This is clear when looking at the implementations and at the docs of the other similar sequence functions.
  2. I also modified the description of the n param for rosidl_runtime_c__U16String__assignn_from_char to clarify that it is the number of 8-bit chars in the string. I also mentioned that the function will return false if n is not even.
  3. Finally, I also added some missing * after /* in docs (to get the usual /**).

Signed-off-by: Christophe Bedard <christophe.bedard@apex.ai>
Signed-off-by: Christophe Bedard <christophe.bedard@apex.ai>
Signed-off-by: Christophe Bedard <christophe.bedard@apex.ai>
@christophebedard christophebedard changed the title Fix u16 sequence docs and improve docs formatting Fix u16 docs and improve docs formatting Apr 26, 2024
Copy link

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Contributor

@clalancette clalancette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

Since this is only a documentation change, and the Rpr jobs are working again, I'm going to merge it in with just that passing. Thanks for updating this!

@clalancette clalancette merged commit 7f22517 into ros2:rolling Apr 26, 2024
4 checks passed
@christophebedard christophebedard deleted the christophebedard/fix-docs branch April 26, 2024 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants