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

Add doc where MutableCharSpan is used to set it's size to 0 if not used. #35250

Closed
hicklin opened this issue Aug 28, 2024 · 0 comments · Fixed by #35176
Closed

Add doc where MutableCharSpan is used to set it's size to 0 if not used. #35250

hicklin opened this issue Aug 28, 2024 · 0 comments · Fixed by #35176
Assignees

Comments

@hicklin
Copy link
Contributor

hicklin commented Aug 28, 2024

Following this comment, add documentation wherever a referance to a MutableCharSpan is passed to say that if this is not edited successfully, it's size should be set to 0.

example, after "@param[out] statusText text describing failure (see description above), size kMaxSizeStatusText."

"If writing to statusText can result in a failure, example due to a string that can be longer that kMaxSizeStatusText, the size of this value should be set to 0 with .reduce_size(0)."

@hicklin hicklin converted this from a draft issue Aug 28, 2024
@hicklin hicklin moved this from Todo to In Progress in [Device Type] Robot Vacuums Aug 30, 2024
@hicklin hicklin self-assigned this Aug 30, 2024
@mergify mergify bot closed this as completed in #35176 Sep 3, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in [Device Type] Robot Vacuums Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant