Skip to content

feat: Change Notice field comment format and unit-test to enforce they exist#1421

Merged
bdferris-v2 merged 4 commits intomasterfrom
issue/1324/rules
May 1, 2023
Merged

feat: Change Notice field comment format and unit-test to enforce they exist#1421
bdferris-v2 merged 4 commits intomasterfrom
issue/1324/rules

Conversation

@bdferris-v2
Copy link
Copy Markdown
Collaborator

@bdferris-v2 bdferris-v2 commented May 1, 2023

As part of the larger Notice documentation refactor (#1324), PR #1365 added support for extracting field documentation from Javadoc comments (aka /** / comment style). Critically, most of the field comments use // after I added them in bulk in PR #1346. This PR switches the style to /* */.

It also adds a unit-test to enforce that each Notice field specifies a comment of this format.

@bdferris-v2
Add a test to ensure all validation notice fields are correctly docum…
d62fc82 
…ented.
@bdferris-v2
Two major changes:
d9493dc 
1) Change Notice field comments from // to /** */ so style so that they are properly picked up in the documentation extractor.
2) Add a unit-test to verify that all Notice fields are documented.
@bdferris-v2 bdferris-v2 requested a review from davidgamez May 1, 2023 05:06
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 1, 2023

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 1, 2023

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

davidgamez
davidgamez requested changes May 1, 2023
View reviewed changes
@bdferris-v2
Copy link
Copy Markdown
Collaborator Author

bdferris-v2 commented May 1, 2023

I incorporated all the suggestions. Thanks!

davidgamez
davidgamez approved these changes May 1, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@davidgamez davidgamez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 1, 2023

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

@bdferris-v2 bdferris-v2 merged commit 465669b into master May 1, 2023
@bdferris-v2 bdferris-v2 deleted the issue/1324/rules branch May 1, 2023 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@davidgamez davidgamez davidgamez approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bdferris-v2 @davidgamez