-
Notifications
You must be signed in to change notification settings - Fork 228
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
Improve binary documentation #330
Conversation
@filmor thanks for all the feedback, I'll use all your suggestions. I figured I had factual errors, hence opening an early draft PR. |
ea6119f
to
9f263e2
Compare
I think I have addressed most/all of @filmor's comments, but may have introduced more factual errors in the process. I've gotten a little busy lately, so I may not be able complete everything in the in checklist in the PR overview at the top, but I'll leave this PR as draft for little a longer. |
9f263e2
to
de1f1be
Compare
de1f1be
to
e214852
Compare
e214852
to
e6c4437
Compare
I removed the |
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.
Very nice, thanks! I only found two minor nits.
Co-authored-by: Magnus <evnu@posteo.de>
Co-authored-by: Magnus <evnu@posteo.de>
For my colleagues and I, one of the hardest parts of coming up to speed with Rustler has been dealing with binaries. Even those of us with years of Rust experience were confused by the difference between
Binary
andOwnedBinary
, despite the fact thatOwned
should say it all. I've tried my best to capture my confusion before I'm too familiar with codebase.Included in this PR:
doc_hidden
tag# Panics
section forOwnedBinary::from_unowned
, I noticed that it could be simplified to the point that it's obvious that it will not panic (it callscopy_from_slice
internally, which can panic, but won't since lengths will be checked before that call)For reviewers: please run
cargo doc --open
and try all the intra-doc links in thebinary
module if possible. I'verustdoc
to be very unreliable at warning on broken links.