Skip to content

feat: Update Notice source code such that field name comments match documentation in RULES.md#1346

Merged
bdferris-v2 merged 5 commits intomasterfrom
issue/1324/rules
Mar 22, 2023
Merged

feat: Update Notice source code such that field name comments match documentation in RULES.md#1346
bdferris-v2 merged 5 commits intomasterfrom
issue/1324/rules

Conversation

@bdferris-v2
Copy link
Copy Markdown
Collaborator

@bdferris-v2 bdferris-v2 commented Mar 1, 2023

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!

@bdferris-v2 bdferris-v2 requested a review from isabelle-dr March 1, 2023 15:06
@bdferris-v2
Copy link
Copy Markdown
Collaborator Author

bdferris-v2 commented Mar 1, 2023

@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
Copy Markdown
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.

@bdferris-v2 bdferris-v2 mentioned this pull request Mar 15, 2023
Merged
4 tasks
@briandonahue
Copy link
Copy Markdown
Contributor

briandonahue commented Mar 16, 2023

@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
Copy Markdown
Collaborator Author

bdferris-v2 commented Mar 16, 2023

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

isabelle-dr
isabelle-dr approved these changes Mar 20, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@isabelle-dr isabelle-dr left a comment •
edited
Loading

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
Copy Markdown
Contributor

isabelle-dr commented Mar 20, 2023

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
Copy Markdown
Contributor

github-actions bot commented Mar 22, 2023

✅ 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
@isabelle-dr isabelle-dr mentioned this pull request Mar 24, 2023
Closed
@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 @briandonahue @ryon
feat: Update Notice source code such that field name comments match d…
4d3dc8d 
…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 <[email protected]>
bradyhunsaker pushed a commit to bradyhunsaker/gtfs-validator that referenced this pull request Apr 25, 2023
@bdferris-v2 @bradyhunsaker
feat: Update Notice source code such that field name comments match d…
6a50bd6 
…ocumentation in RULES.md (MobilityData#1346)
@bdferris-v2 bdferris-v2 mentioned this pull request May 1, 2023
Merged
4 tasks
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

Assignees

No one assigned

Labels

None yet

Projects

Schedule Validator Q2 backlog
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[feature request / refactor] Produce structured data containing human-readable code descriptions (refactor RULES.md)

3 participants

@bdferris-v2 @briandonahue @isabelle-dr