GODRIVER-3180 Document clearly that x/ package APIs are not stable. #1631
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
API Change ReportNo changes found! |
blink1073
pushed a commit
to blink1073/mongo-go-driver
that referenced
this pull request
May 8, 2024
…ongodb#1631) (cherry picked from commit 6a53da6)
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.
GODRIVER-3180
Summary
Document clearly that
x/package APIs are not stable.Background & Motivation
The main way we currently notify users that packages in the
x/directory are unstable is using the README in thex/directory. However, that's easy to miss for many users. Considering the negative impact that breaking changes can have, we should make that warning more obvious to users who only interact with the Go documentation.