Expanded summary sections to include sentence and component summaries. #8
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
Merge latest changes.
- Changed General and Technical Template to include Sentence Summary, Paragraph Summary, Component Summary. - Removed Component List and old Summary heading from the General and Technical templates. - Changed all MIPs to follow the new templates. - Wrote sentence summaries for each MIP. - Paragraph Summaries for each MIP are a direct copy of the previous summaries. - Wrote component summaries for each component in each MIP.
|
Thanks for adding that. Helps with the Clarity principle :) |
CPSTL
pushed a commit
that referenced
this pull request
Oct 8, 2020
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.
Component list I removed because it has too much overlap with Component Summary. Note that it may be a good idea to do that for the external reference list too if that PR is taken.
Component summaries are sometimes but not always superfluous, same for sentence summaries.
Some Paragraph summaries are too short, some are unclear, some are more motivation than summary. I'll try to cover those in another pass.