-
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
docs: Update instructions to run the validator #1115
Conversation
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.
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]` |
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.
I would change this so that it is similar to my comment at line 22.
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Thanks for the feedback, I updated the instructions to replace [ with {. |
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.
LGTM! Thanks @isabelle-dr :)
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-doc
needed 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 test
to make sure you didn't break anythingInstructions Before:
Instructions After:
Parameters Before:
Parameters After: