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: Change Notice field comment format and unit-test to enforce they exist #1421

Merged
merged 4 commits into from
May 1, 2023

Conversation

bdferris-v2
Copy link
Collaborator

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.

  • 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)

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.
@github-actions
Copy link
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
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.

@bdferris-v2
Copy link
Collaborator Author

I incorporated all the suggestions. Thanks!

Copy link
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
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
333 checks passed
@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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants