-
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
docs: Update new rules documentation #837
Conversation
This PR attempts to simply the new rules documentation by taking the approach of providing an example, and then walking through sections of the example for both FileValidators and SingleEntityValidators, but always presenting FileValidators file to follow the initially introduced example of the TripUsabilityValidator. It also attempts to shorten text when possible and provide some additional context when needed. It also fixes references to the SingleEntityValidator sections, some of which mixed references to FeedExpirationDateValidator and FeedServiceDateValidator.
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.
Thanks @barbeau for this more narrative version! Just a few minor changes in line.
Co-authored-by: Lionel Nébot Janvier <35747326+lionel-nj@users.noreply.github.com>
Co-authored-by: Lionel Nébot Janvier <35747326+lionel-nj@users.noreply.github.com>
Thanks @lionel-nj! I committed your suggestions, and fixed another typo I found. |
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.
👍🏾 lgtm!
Summary:
This PR attempts to simply the new rules documentation by taking the approach of providing an example, and then walking through sections of the example for both FileValidators and SingleEntityValidators, but always presenting FileValidators file to follow the initially introduced example of the TripUsabilityValidator. It also attempts to shorten text when possible and provide some additional context when needed.
It also fixes references to the SingleEntityValidator sections, some of which mixed references to FeedExpirationDateValidator and FeedServiceDateValidator.
Expected behavior:
New rules documentation should present an example and then walk the reader through it, providing only the basic information needed to understand the example.
A lot of text in-line was changed with existing text moved around, so it will probably be easier to view this change in it's entirely by clicking on the 3 dots in the "Files changed" tab and doing "View file".
gradle test
to make sure you didn't break anything