Conversation
cka-y
changed the title
📝 Acceptance Test Report📋 Summary✅ The rule acceptance has passed for commit 900b97b 📊 Notices ComparisonNew Errors (0 out of 1809 datasets, ~0%) ✅No changes were detected due to the code change. Dropped Errors (0 out of 1809 datasets, ~0%) ✅No changes were detected due to the code change. New Warnings (0 out of 1809 datasets, ~0%) ✅No changes were detected due to the code change. Dropped Warnings (0 out of 1809 datasets, ~0%) ✅No changes were detected due to the code change. 🛡️ Corruption Check0 out of 1809 sources (~0 %) are corrupted. ⏱️ Performance Assessment📈 Validation TimeAssess the performance in terms of seconds taken for the validation process.
📜 Memory Consumption
|
...rc/main/java/org/mobilitydata/gtfsvalidator/processor/summary/SummaryDocCommentsFactory.java
Outdated
Show resolved
Hide resolved
| */ | ||
| public final String countryCode; | ||
|
|
||
| /** Date of the validation. */ |
There was a problem hiding this comment.
I think this is the date used for compiling notices related to dates. It can be different from the date the validation was run.
Normally this date should be the same as the date the validator was run for someone using the web validator.
But for the cli version a different date can be specified.
There was a problem hiding this comment.
cc @emmambd for the description. What should it be changed to?
There was a problem hiding this comment.
@jcpitre I'm confused how notice compiling time and validation time differ - can you share an example of what this would look like in the CLI?
There was a problem hiding this comment.
Merging this PR for now to be able to complete #1964. We can always open a new issue to change the description of this field if necessary 🙂
cli/build.gradle
Outdated
| implementation project(':main') | ||
| implementation 'com.beust:jcommander:1.48' | ||
| implementation 'com.google.code.gson:gson:2.8.6' | ||
| implementation 'com.google.code.gson:gson:2.9.1' |
There was a problem hiding this comment.
Just a heads-up: This will cause merge conflicts in dependencies since the PR that resolves dependency versions has already been merged, and it uses libs.gson.
📝 Acceptance Test Report📋 Summary✅ The rule acceptance has passed for commit 07a1bab 📊 Notices ComparisonNew Errors (0 out of 1821 datasets, ~0%) ✅No changes were detected due to the code change. Dropped Errors (0 out of 1821 datasets, ~0%) ✅No changes were detected due to the code change. New Warnings (0 out of 1821 datasets, ~0%) ✅No changes were detected due to the code change. Dropped Warnings (0 out of 1821 datasets, ~0%) ✅No changes were detected due to the code change. 🛡️ Corruption Check0 out of 1821 sources (~0 %) are corrupted. ⏱️ Performance Assessment📈 Validation TimeAssess the performance in terms of seconds taken for the validation process.
📜 Memory Consumption
|
4 participants
Summary
This PR improves documentation. A preview of the updated summary metadata can be found here.
Key Changes:
Annotation Processors:
Added the
summaryannotation processorDocumentation Enhancements:
Updated the Javadoc for all summary metadata elements.
Expected Behavior:
The documentation is automatically generated from Javadoc comments by the annotation processor, which produces a
summary-metadata.jsonfile in the web client’s static folder. This file is then used to update the documentation displayed onrules.html. When adding new fields ensure each element is properly documented. Corresponding tests verify that these standards are maintained.Please make sure these boxes are checked before submitting your pull request - thanks!
gradle testto make sure you didn't break anything