Skip to content

fix: Inconsistencies in RULES.md against underlying source#1341

Merged
isabelle-dr merged 2 commits intomasterfrom
issue/1324/rules
Feb 27, 2023
Merged

fix: Inconsistencies in RULES.md against underlying source#1341
isabelle-dr merged 2 commits intomasterfrom
issue/1324/rules

Conversation

@bdferris-v2
Copy link
Copy Markdown
Collaborator

@bdferris-v2 bdferris-v2 commented Feb 20, 2023

Specifically, this PR updates RULES.md to:

  • Fix incorrectly named fields: docs should match underlying field names in Java source / JSON schema
  • Add missing fields: docs should contain all fields from Java source / JSON schema
  • Fix inconsistent formatting
  • Fix two incorrectly-named fields in the Java source

This is an intermediate PR that brings us one step closer to alignment and generation of Notice documentation from the source code itself per #1324.

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

@bdferris-v2
Copy link
Copy Markdown
Collaborator Author

bdferris-v2 commented Feb 20, 2023

@isabelle-dr this is mostly a RULES.md update so assigning to your for review

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 20, 2023

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

@isabelle-dr isabelle-dr requested a review from emmambd February 27, 2023 15:42
isabelle-dr
isabelle-dr approved these changes Feb 27, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@isabelle-dr isabelle-dr left a comment

Choose a reason for hiding this comment

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

LGTM, thank you for this contribution @bdferris-v2 !

@isabelle-dr isabelle-dr linked an issue Feb 27, 2023 that may be closed by this pull request
Missing notice details for three validator rules #1133
Closed
6 tasks
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 27, 2023

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

@isabelle-dr isabelle-dr merged commit 30e6c69 into master Feb 27, 2023
@isabelle-dr isabelle-dr deleted the issue/1324/rules branch February 27, 2023 18:40
@isabelle-dr isabelle-dr linked an issue Mar 27, 2023 that may be closed by this pull request
[feature request / refactor] Produce structured data containing human-readable code descriptions (refactor RULES.md) #1324
Closed
ryon pushed a commit to JarvusInnovations/gtfs-validator that referenced this pull request Apr 1, 2023
@bdferris-v2 @isabelle-dr @ryon
Update RULES.md to fix incorrectly named fields, missing fields, and …
002f672 
…inconsistent formatting. (MobilityData#1341)

Co-authored-by: isabelle-dr <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@isabelle-dr isabelle-dr isabelle-dr approved these changes

@emmambd emmambd Awaiting requested review from emmambd

Assignees

No one assigned

Labels

None yet

Projects

Schedule Validator Q2 backlog
Status: Done

Milestone

No milestone

2 participants

@bdferris-v2 @isabelle-dr