-
Notifications
You must be signed in to change notification settings - Fork 98
Panic and error documentation #407
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
Conversation
joaoantoniocardoso
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ty
|
Will you have any free space to finalize this PR? @pv42 It would be quite cool to have this on the next release along with Add wrapper for char arrays to access str conveniently #388. |
onur-ozkan
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
This PR adds better error and documentation to
mavlink-coreBreaking
To have consistent
read_function names I renamed the following group of functions:read_raw_versioned_msg[_async][_signed]->read_versioned_raw_message[_async][_signed]Changes
# Errorsand# Panicsdoc sections to all applicable public functions inmavlink-coreread_andwrite_functions and their errors in mavlink-core/src/lib.rscrate::error::MessageReadErrorLints
There are 2 clippy lints that check for the existence of these sections but in my experience the one for panics is not very useful since it has many false positives and negatives. Therefore I did not enable them.
Other
Only lock signing mutex when message actually needs to be signed, this is a minor performance improvement for the
signingfeature. This is so minor that I didn't want to put it in a separate PR.