-
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: Extract notice docs from source-code for in-app use and schema export #1365
Conversation
…d to configure and document validation notices in source code.
…This will allow us to break up some potential circular dependencies with upcoming support for notice documentation generation.
…ation extraction for notices.
✅ Rule acceptance tests passed. |
core/src/main/java/org/mobilitydata/gtfsvalidator/notice/CsvParsingFailedNotice.java
Show resolved
Hide resolved
@bdferris-v2 let's connect to discuss where the generated documentation can live to make it easily accessible to consumers. |
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! 💪
✅ Rule acceptance tests passed. |
✅ Rule acceptance tests passed. |
…export (MobilityData#1365) * Initial entry for @GtfsValidationNotice annotation, which will be used to configure and document validation notices in source code. * Move key annotation and entity interfaces into a new `model` module. This will allow us to break up some potential circular dependencies with upcoming support for notice documentation generation. * Initial entry for processor:notices module, with support for documentation extraction for notices. * Fix test on Windows.
Summary:
Per discussion in #1324, this PR adds support for extracting documentation from notice source code, to be included as JSON resources bundles in the compiled application. These will be included in the now-expanded JSON schema export feature, including comments, reference links, and hopefully enough info to generate RULES.md from source.
See https://bit.ly/gtfs-validator-notice-documentation for initial design discussion.
gradle test
to make sure you didn't break anything