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: Update Notice source code such that field name comments match documentation in RULES.md #1346

Merged
merged 5 commits into from
Mar 22, 2023

Conversation

bdferris-v2
Copy link
Collaborator

As part of our effort to alignment documentation and source code in #1324, this PR applies an automated transform to update the comments of each Notice field in source to match the equivalent field documentation string from RULES.md. This gets us one step closer to generating RULES.md from source code directly.

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

  • 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

@bdferris-v2
Copy link
Collaborator Author

@isabelle-dr I know this review looks a little bit scary, but it's largely an automated transformation from RULES.md to source code. As always, curious what you think.

@github-actions
Copy link
Contributor

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

@briandonahue
Copy link
Collaborator

@bdferris-v2 in looking at this for #1289 I noticed some copy/paste mistakes where row number comment was copied for file name field, so I fixed those.

@bdferris-v2
Copy link
Collaborator Author

@briandonahue those are actually errors in the source RULES.md file :) But fixing them here is appreciated, thanks!

Copy link
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.

Hey @bdferris-v2, sorry for the late answer, and thank you for this first step in the direction of a programmatically generated doc!
This LGTM.
We should keep in mind that as we work on this, all new ...Notice.java and ...Validator.java files that add new notices will need to include this syntax.

@isabelle-dr
Copy link
Contributor

After the conflicts are resolved, I think we're good to merge this PR!
cc @davidgamez

@isabelle-dr isabelle-dr added this to the 4.1.0 milestone Mar 20, 2023
@github-actions
Copy link
Contributor

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

@bdferris-v2 bdferris-v2 merged commit 0584e7b into master Mar 22, 2023
@bdferris-v2 bdferris-v2 deleted the issue/1324/rules branch March 22, 2023 21:46
ryon pushed a commit to JarvusInnovations/gtfs-validator that referenced this pull request Apr 1, 2023
…ocumentation in RULES.md (MobilityData#1346)

* Update Notice source code such that field name comments match corresponding documentation in RULES.md.

* Update RULES.md to fix incorrectly named fields, missing fields, and inconsistent formatting.

* fix copy/paste comment errors

---------

Co-authored-by: Brian Donahue <brian.donahue@vitreosolutions.com>
bradyhunsaker pushed a commit to bradyhunsaker/gtfs-validator that referenced this pull request Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
3 participants