- Notifications
You must be signed in to change notification settings - Fork898
Indicate Go API stability in README#175
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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.
Pull Request Overview
This PR documents that the module's exported Go API should be considered unstable.
- Added a "Library Usage" section to clarify the potential for breaking changes in the exported API.
- Updated the README with a disclaimer encouraging users to file an issue if they require a stable API.
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.
Perfect
4cf96ab intomainUh oh!
There was an error while loading.Please reload this page.
Description
Some identifiers were recently exported for internal use, but this is not a commitment to a stable API, so let's document that.