-
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: Change Notice field comment format and unit-test to enforce they exist #1421
Conversation
1) Change Notice field comments from // to /** */ so style so that they are properly picked up in the documentation extractor. 2) Add a unit-test to verify that all Notice fields are documented.
✅ Rule acceptance tests passed. |
✅ Rule acceptance tests passed. |
core/src/main/java/org/mobilitydata/gtfsvalidator/notice/MixedCaseRecommendedFieldNotice.java
Outdated
Show resolved
Hide resolved
main/src/main/java/org/mobilitydata/gtfsvalidator/validator/DateTripsValidator.java
Outdated
Show resolved
Hide resolved
main/src/main/java/org/mobilitydata/gtfsvalidator/validator/FeedServiceDateValidator.java
Outdated
Show resolved
Hide resolved
...src/main/java/org/mobilitydata/gtfsvalidator/validator/ShapeIncreasingDistanceValidator.java
Outdated
Show resolved
Hide resolved
...src/main/java/org/mobilitydata/gtfsvalidator/validator/ShapeIncreasingDistanceValidator.java
Outdated
Show resolved
Hide resolved
.../main/java/org/mobilitydata/gtfsvalidator/validator/StopTimeIncreasingDistanceValidator.java
Outdated
Show resolved
Hide resolved
.../main/java/org/mobilitydata/gtfsvalidator/validator/StopTimeIncreasingDistanceValidator.java
Outdated
Show resolved
Hide resolved
main/src/test/java/org/mobilitydata/gtfsvalidator/validator/NoticeDocumentationTest.java
Show resolved
Hide resolved
core/src/main/java/org/mobilitydata/gtfsvalidator/notice/PointNearPoleNotice.java
Outdated
Show resolved
Hide resolved
core/src/main/java/org/mobilitydata/gtfsvalidator/notice/EmptyFileNotice.java
Outdated
Show resolved
Hide resolved
I incorporated all the suggestions. Thanks! |
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.
🚀
✅ Rule acceptance tests passed. |
As part of the larger Notice documentation refactor (#1324), PR #1365 added support for extracting field documentation from Javadoc comments (aka /** / comment style). Critically, most of the field comments use // after I added them in bulk in PR #1346. This PR switches the style to /* */.
It also adds a unit-test to enforce that each Notice field specifies a comment of this format.
gradle test
to make sure you didn't break anything