feat: Split the notice doc comment into a short summary string and additional documentation. #1452
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 is a usability tweak on the notice documentation support that was implemented in #1324.
We enforce that notice doc comments have the following form:
We represented that internally as a single combined comment string, but there are uses where we'd like to split out the short summary string and the additional optional documentation so that they can be used and rendered separately, where appropriate. This PR implements that split.
Please make sure these boxes are checked before submitting your pull request - thanks!
gradle test
to make sure you didn't break anything