Skip to content
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.

Sign up for GitHub

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

Minor documentation changes #1658

Merged
merged 3 commits into from
Jan 25, 2024
Merged

Minor documentation changes #1658

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb5060f
Minor documentation changes
jcpitre Jan 24, 2024
c57d513
Modified according to PR comments.
jcpitre Jan 24, 2024
debbcee
Merge branch 'master' into 1292-minor-documentation-changes-for-the-d…
jcpitre Jan 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cli/src/main/java/org/mobilitydata/gtfsvalidator/cli/Arguments.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public class Arguments {
description =
"Date to simulate when validating, in ISO_LOCAL_DATE format like "
+ "'2001-01-30'. By default, the current date is used. "
+ "This option enables debugging rules like feed expiration.")
+ "This option can be used to debug rules like feed expiration.")
private String dateString;

@Parameter(
Expand Down
5 changes: 3 additions & 2 deletions docs/USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
**Full list of command line parameters available**

| Short name | Long name | required? | Description |
| ---------- | ----------------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|------------|-------------------------------| ---------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `-i` | `--input` | Conditionally required | The path to the GTFS file (e.g., `/myDirectory/gtfs.zip`). Required if `-u` or `--url` is not provided. |
| `-u` | `--url` | Conditionally Required | `--url` or `-u`: the fully qualified URL to the GTFS file (e.g., `https://www.abc.com/gtfs.zip`). Required if `-i` or `--input` is not provided. |
| `-o` | `--output` | Required | Path to where the validation report will be stored (e.g., `output`) |
Expand All @@ -20,7 +20,8 @@
| `-r` | `--html_report_name` | Optional | Name of the HTML validation report (including `.html` extension). |
| `-e` | `--system_errors_report_name` | Optional | Name of the system errors report (including `.json` extension). |
| `-n` | `--export_notices_schema` | Optional | Export notice schema as a json file. |
| `-p` | `--pretty` | Optional | Pretty JSON validation report. If specified, the JSON validation report will be printed using JSON Pretty print. This does not impact data parsing. |
| `-p` | `--pretty` | Optional | Pretty JSON validation report. If specified, the JSON validation report will be printed using JSON Pretty print. This does not impact data parsing. |
| `-d` | `--date` | Optional | Date to simulate when validating, in ISO_LOCAL_DATE format like '2001-01-30'. By default, the current date is used. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jcpitre "Date to simulate when validating" is a bit vague. What about "The date used to validate the feed for time-based rules, e.g feed_expiration_30_days."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I was just copying the text from @bradyhunsaker's changes, but less vague is always good.


⚠️ Note that exactly one of the following options must be provided: `--url` or `--input`.

Expand Down
Loading