Skip to content

Commit dddcd30

Browse files
authored
Merge pull request #22 from turnerlabs/feature/update_readme
Update README
2 parents f14569c + 5c00be0 commit dddcd30

2 files changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,3 +148,15 @@ optional arguments:
148148
SITE_MEMBERS, INTEGRATIONS, ADVANCED_RULES
149149
--yes, -y Automatic yes to prompts
150150
```
151+
152+
### Validate Command
153+
```shell
154+
$ sigsci_site_manager validate --help
155+
usage: sigsci_site_manager validate [-h] --name NAME --target URL [--dry-run]
156+
157+
optional arguments:
158+
-h, --help show this help message and exit
159+
--name NAME, -n NAME Site name
160+
--target URL, -d URL URL to test against
161+
--dry-run Print actions without making any changes
162+
```

sigsci_site_manager/site_manager.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -238,9 +238,9 @@ def _validate_category_list(value: str):
238238
validate_parser.set_defaults(func=do_validate)
239239
validate_parser.add_argument('--name', '-n', metavar='NAME', required=True,
240240
dest='site_name', help='Site name')
241-
validate_parser.add_argument('--target', '-d', metavar='HOSTNAME',
241+
validate_parser.add_argument('--target', '-d', metavar='URL',
242242
required=True, dest='target',
243-
help='Hostname or IP to test against')
243+
help='URL to test against')
244244
validate_parser.add_argument(
245245
'--dry-run', required=False, action='store_true', dest='dry_run',
246246
help='Print actions without making any changes')

0 commit comments

Comments
 (0)