docs: Update instructions to run the validator#1115
Merged
maximearmstrong merged 7 commits intomasterfrom Apr 20, 2022
Merged
Conversation
maximearmstrong
suggested changes
Mar 23, 2022
Contributor
maximearmstrong
left a comment
There was a problem hiding this comment.
Great update! A few comments in-line before approval :)
README.md
Outdated
| To validate a GTFS dataset on your computer: | ||
| You can run this validator using a GTFS dataset on your computer, or from a URL. | ||
| - To validate a GTFS dataset on your computer, run the following command in the terminal, replacing the text in brackets: | ||
| - `java -jar [name of the jar file] -i [path to the GTFS file] -o [name of the output directory that will be created]` |
Contributor
There was a problem hiding this comment.
I would change this so that it is similar to my comment at line 22.
Co-authored-by: Maxime Armstrong <[email protected]>
Co-authored-by: Maxime Armstrong <[email protected]>
Co-authored-by: Maxime Armstrong <[email protected]>
Co-authored-by: Maxime Armstrong <[email protected]>
Contributor
Author
|
Thanks for the feedback, I updated the instructions to replace [ with {. |
maximearmstrong
approved these changes
Apr 20, 2022
Contributor
maximearmstrong
left a comment
There was a problem hiding this comment.
LGTM! Thanks @isabelle-dr :)
This file contains hidden or 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
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:
After receiving feedback from users on our instructions to run the validator via the command line, we identified the following pain points:
test-pack-docneeded to be unzipped to access the jar fileThis PR solves these problems by:
This PR also includes:
Please make sure these boxes are checked before submitting your pull request - thanks!
Run the unit tests withgradle testto make sure you didn't break anythingInstructions Before:
Instructions After:
Parameters Before:
Parameters After: