RUST-998 / RUST-2244 Documentation improvements #581
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
isabelatkinson
changed the title
missing_docs lint
isabelatkinson
commented
Jul 23, 2025
| } | ||
|
|
||
| impl<'a> TryInto<RawBsonRef<'a>> for RawElement<'a> { | ||
| impl<'a> TryFrom<RawElement<'a>> for RawBsonRef<'a> { |
Contributor
Author
There was a problem hiding this comment.
flipped these implementations (https://doc.rust-lang.org/std/convert/trait.TryInto.html#implementing-tryinto)
abr-egn
approved these changes
Jul 24, 2025
| } | ||
|
|
||
| /// Constructs a new [`RawDocumentBuf`], validating _only_ the | ||
| /// following invariants: |
Contributor
There was a problem hiding this comment.
I might be less precise here ("validating only the outer envelope of the buffer" or some such) to give room for the implementation to make minor changes without having to publicize them, but definitely a reasonable judgement call either way :)
Contributor
Author
There was a problem hiding this comment.
This is copied from the docs of the method above - I'm going to leave as-is as I expect this logic to be fairly stable, and I think it's helpful for users to know exactly what is and isn't being validated.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
RUST-998 / RUST-2244