Add docs explaining generated code and its API #39
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
Motivation: Users should be able to understand how the generated code is structured and how it may change over time. Modifications: Add two docs: 1. Explain the structure of the generate code and how to navigate it. 2. Explain how the generated code may change and hot to ensure it doesn't cause API breakages. Result: Better docs
glbrntt
added
area/documentation
gjcairo
approved these changes
Jan 29, 2025
Comment on lines
67
to
68
| ones. Existing API will never be removed and deprecated APIs will continue to | ||
| function. |
There was a problem hiding this comment.
Maybe this is obvious, but should we clarify that "never" means "unless we tag a new major"?
There was a problem hiding this comment.
Good idea, I think that's worth stating.
glbrntt
commented
Jan 29, 2025
Sources/GRPCProtobuf/Documentation.docc/Articles/API-stability-of-generated-code.md
Outdated
Show resolved
Hide resolved
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.
Motivation:
Users should be able to understand how the generated code is structured and how it may change over time.
Modifications:
Add two docs:
Result:
Better docs