Skip to content

Feat: Bulk update Notice Javadoc to include content from RULES.md.#1428

Merged
bdferris-v2 merged 6 commits intomasterfrom
issue/1324/docs
May 15, 2023
Merged

Feat: Bulk update Notice Javadoc to include content from RULES.md.#1428
bdferris-v2 merged 6 commits intomasterfrom
issue/1324/docs

Conversation

@bdferris-v2
Copy link
Copy Markdown
Collaborator

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

As part of #1324, this PR updates the Javadoc comments associated with each validation notice to include content extracted from RULES.md. Where appropriate, the comments have been updated to match the following form:

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

See new documentation and enforcement in PR #1429.

Please make sure these boxes are checked before submitting your pull request - thanks!

@bdferris-v2
Copy link
Copy Markdown
Collaborator Author

Adding @isabelle-dr for notice documentation content.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 3, 2023

✅ Rule acceptance tests passed.
New Errors: 1 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: 1 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: 026acf9
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

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.

LGTM!

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 5, 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: 68964e2
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@github-actions
Copy link
Copy Markdown
Contributor

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

@bdferris-v2 bdferris-v2 merged commit 4ac4ba6 into master May 15, 2023
@bdferris-v2 bdferris-v2 deleted the issue/1324/docs branch May 15, 2023 22:48
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.

2 participants