diff --git a/cli/src/main/java/org/mobilitydata/gtfsvalidator/cli/Arguments.java b/cli/src/main/java/org/mobilitydata/gtfsvalidator/cli/Arguments.java index d79bfbfeeb..9e614c82c4 100644 --- a/cli/src/main/java/org/mobilitydata/gtfsvalidator/cli/Arguments.java +++ b/cli/src/main/java/org/mobilitydata/gtfsvalidator/cli/Arguments.java @@ -57,9 +57,9 @@ public class Arguments { @Parameter( names = {"-d", "--date"}, 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.") + "The date used to validate the feed for time-based rules, e.g feed_expiration_30_days, " + + "in ISO_LOCAL_DATE format like '2001-01-30'. By default, the current date is used. " + + "This option can be used to debug rules like feed expiration.") private String dateString; @Parameter( diff --git a/docs/USAGE.md b/docs/USAGE.md index f6133fa2ba..2f03057019 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -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`) | @@ -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 | The date used to validate the feed for time-based rules, e.g feed_expiration_30_days, in ISO_LOCAL_DATE format like '2001-01-30'. By default, the current date is used. | ⚠️ Note that exactly one of the following options must be provided: `--url` or `--input`.