Skip to content

feat: Additional test to enforce documentation comment conventions#1450

Merged
bdferris-v2 merged 10 commits intomasterfrom
issue/1324/rules_documentation_test
May 31, 2023
Merged

feat: Additional test to enforce documentation comment conventions#1450
bdferris-v2 merged 10 commits intomasterfrom
issue/1324/rules_documentation_test

Conversation

@bdferris-v2
Copy link
Copy Markdown
Collaborator

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

This PR adds an additional unit-test to enforce our documentation comment conventions, per https://github.com/MobilityData/gtfs-validator/blob/master/docs/NEW_RULES.md#2-document-the-new-rule. This is a cleanup task for #1324.

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

@bdferris-v2 bdferris-v2 requested a review from davidgamez May 26, 2023 16:45
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 26, 2023

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

davidgamez
davidgamez requested changes May 29, 2023
View reviewed changes
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 29, 2023

✅ 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: 583492d
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 31, 2023

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

@bdferris-v2 bdferris-v2 merged commit 0a854c1 into master May 31, 2023
@bdferris-v2 bdferris-v2 deleted the issue/1324/rules_documentation_test branch May 31, 2023 15:16
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.

4 participants

@bdferris-v2 @davidgamez @KClough @briandonahue