feat(AIP-4210): add code gen diagram + tweaks #1148
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
alexander-fenster
approved these changes
Jun 22, 2023
jskeet
reviewed
Jun 26, 2023
jskeet
approved these changes
Jul 25, 2023
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.
This adds an intentionally very simple diagram to explain the existing, core code generation flow, automation aside. The diagram looks like this:
This also cleans up the
Protobuf pluginsection a bit to be more accessible/direct, adds guidance on not generatingmessageandenumdescriptor code (left asshould notto grandparent in Python proto-plus code gen), adds guidance on not using protoc insertion points, and some other small tweaks.