Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Split the notice doc comment into a short summary string and additional documentation. #1452

Merged
merged 2 commits into from
May 26, 2023

Conversation

bdferris-v2
Copy link
Collaborator

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:

/**
 * Short text describing the notice in a single line (required).
 *
 * Additional text further describing the notice on new lines (optional).
 */

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!

  • Run the unit tests with gradle test to make sure you didn't break anything
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • Include screenshot(s) showing how this pull request works and fixes the issue(s)

@bdferris-v2 bdferris-v2 requested a review from KClough May 26, 2023 18:29
@github-actions
Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1428 sources (~0 %) are corrupted.
Commit: ce39f3e
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@bdferris-v2 bdferris-v2 merged commit ef871ae into master May 26, 2023
333 checks passed
@bdferris-v2 bdferris-v2 deleted the issue/1324/summary_vs_details branch May 26, 2023 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants