-
Notifications
You must be signed in to change notification settings - Fork 100
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
Conversation
…inconsistent formatting.
…onding documentation in RULES.md.
@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. |
✅ Rule acceptance tests passed. |
@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. |
@briandonahue those are actually errors in the source |
There was a problem hiding this 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.
After the conflicts are resolved, I think we're good to merge this PR! |
✅ Rule acceptance tests passed. |
…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]>
…ocumentation in RULES.md (MobilityData#1346)
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 generatingRULES.md
from source code directly.Please make sure these boxes are checked before submitting your pull request - thanks!
gradle test
to make sure you didn't break anything