docs: document Options in get_highest_* and ensure_invariants #9529
Conversation
This file contains 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
I was using the `get_highest_*` methods and noticed that they did not explain the exact meaning of `Some` or `None` in docs. This is now explained, along with more docs for `ensure_invariants`.
Rjected
added
C-docs
shekhirin
approved these changes
Jul 15, 2024
DaniPopes
approved these changes
Jul 15, 2024
mattsse
approved these changes
Jul 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I was using the
get_highest_*methods and noticed that they did not explain the exact meaning ofSomeorNonein docs. This is now explained, along with more docs forensure_invariants.