Skip to content

feat: Add documentation update + unit-test for new notice doc conventions.#1429

Merged
davidgamez merged 6 commits intomasterfrom
issue/1324/docs_about_docs
May 16, 2023
Merged

feat: Add documentation update + unit-test for new notice doc conventions.#1429
davidgamez merged 6 commits intomasterfrom
issue/1324/docs_about_docs

Conversation

@bdferris-v2
Copy link
Copy Markdown
Collaborator

As part of #1324, this PR updates the documentation in NEW_RULES.md to describe how notices should now be document. This PR also includes an updated unit-test to catch some common formatting errors (e.g. using Javadoc conventions when we should be using Markdown instead).

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 3, 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: 56d4afc
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: 6c29200
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: 33a0a1f
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@davidgamez davidgamez merged commit 85f18d2 into master May 16, 2023
@davidgamez davidgamez deleted the issue/1324/docs_about_docs branch May 16, 2023 01:27
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