MONGOCRYPT-696 document "range" as unstable #832
Merged
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
kevinAlbs
changed the title
Generated with: ``` python strip_header.py ../../src/mongocrypt.h | pbcopy - ```
kevinAlbs
force-pushed
the
document-range-as-unstable
branch
from
018611e
to
a19676a
Compare
adriandole
approved these changes
Jun 17, 2024
kevinAlbs
added a commit
that referenced
this pull request
Jun 17, 2024
* document "range" as unstable
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.
Summary
Document "range" as unstable.
Background & Motivation
There are pending changes that may impact "range" in libmongocrypt (SERVER-91077).
I expect "range" should have kept documentation indicating instability. I consider this a bug and intend to include this documentation in a 1.10.1 release.
This is expected to be a short-term documentation note and to be removed before resolving MONGOCRYPT-584.
This is related to mongodb/specifications#1601 to document the driver API as unstable.