-
Notifications
You must be signed in to change notification settings - Fork 101
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: Initial entry for @GtfsValidationNotice annotation #1361
Conversation
…d to configure and document validation notices in source code.
core/src/main/java/org/mobilitydata/gtfsvalidator/annotation/GtfsValidationNotice.java
Outdated
Show resolved
Hide resolved
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.
LGreatTM!
✅ Rule acceptance tests passed. |
As an FYI to @isabelle-dr in case you have any feedback on the proposed design. |
…This will allow us to break up some potential circular dependencies with upcoming support for notice documentation generation.
I discussed this offline with @davidgamez but I have proposed a refactor to where some key annotations and entity interface are stored (#1362) that will breakup a potential circular dependency. Critically, we want to use the new @GtfsValidationNotice annotation for notice processing, but there are already notices defined in I have proposed moving the annotations into their own module. I think this has some nice properties down the road for splitting up our model API and our business logic, so I think it's a net win. I will update this PR based on the refactor PR. |
✅ Rule acceptance tests passed. |
✅ Rule acceptance tests passed. |
…a#1361) * Initial entry for @GtfsValidationNotice annotation, which will be used to configure and document validation notices in source code.
…a#1361) * Initial entry for @GtfsValidationNotice annotation, which will be used to configure and document validation notices in source code.
As part of on-going work for #1324 for automatic generation of notice documentation from source code, this PR introduces @GtfsValidationNotice, an annotation that will be used to configure and document validation notices in source code.
As generally described in https://bit.ly/gtfs-validator-notice-documentation, this annotation will be applied to all ValidationNotice classes in a follow-up PR. It will then be used as run-time to resolve a notice's severity and also to generate documentation for the notice.
I'm introducing the annotation in its own PR so that we can confirm the API before I do the large-scale transformation of the code-base to add it. I do include documentation for one notice as an example of its usage.
Please make sure these boxes are checked before submitting your pull request - thanks!
gradle test
to make sure you didn't break anything