chore: additional annotation for notice export #922
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lionel-nj
changed the title
added 2 commits
July 8, 2021 15:45
…-for-notice-export # Conflicts: # core/src/main/java/org/mobilitydata/gtfsvalidator/notice/CsvParsingFailedNotice.java # main/src/main/java/org/mobilitydata/gtfsvalidator/validator/BlockTripsWithOverlappingStopTimesValidator.java # main/src/main/java/org/mobilitydata/gtfsvalidator/validator/DuplicateRouteNameValidator.java
barbeau
reviewed
Jul 8, 2021
| * Annotation to be used on notice constructor. This specifies the constructor to be considered | ||
| * while exporting notice information. | ||
| */ | ||
| public @interface NoticeExport {} |
There was a problem hiding this comment.
@lionel-nj One comment here - I would suggest renaming this annotation and providing a more detailed description regarding the exact use case for which it exists.
For example, I think SchemaExport may be a better name here, or NoticeSchema, or something with schema in it, to distinguish it from the export of the notices themselves. It's not clear by the name or description of the annotation what exactly the annotation is used for - I'd link to the class that processes it too when that exists.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
This PR provides support to define a new annotation
NoticeExport. This annotation is to be used on notice constructor. This specifies the constructor to be considered while exporting notice information.This relates to #899
Expected behavior:
No code change for now. Same tests should pass.
Please make sure these boxes are checked before submitting your pull request - thanks!
gradle testto make sure you didn't break anything[ ] Include screenshot(s) showing how this pull request works and fixes the issue(s)