Skip to content

Commit

Permalink
manubot#337 update help message.
Browse files Browse the repository at this point in the history
  • Loading branch information
xihh87 committed Jun 29, 2022
1 parent ed3ed86 commit 2acc3cf
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ usage: manubot process [-h] --content-directory CONTENT_DIRECTORY
--skip-citations [--cache-directory CACHE_DIRECTORY]
[--clear-requests-cache] [--skip-remote]
[--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
[-t TIMEOUT_SECONDS]
Process manuscript content to create outputs for Pandoc consumption. Performs
bibliographic processing and templating.
Expand Down Expand Up @@ -149,6 +150,8 @@ options:
repository remotes.
--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
Set the logging level for stderr logging
-t TIMEOUT_SECONDS, --timeout TIMEOUT_SECONDS
timeout for web requests
```

#### Manual references
Expand Down Expand Up @@ -183,6 +186,7 @@ usage: manubot cite [-h] [--output OUTPUT]
[--csl CSL] [--bibliography BIBLIOGRAPHY]
[--no-infer-prefix] [--allow-invalid-csl-data]
[--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
[-t TIMEOUT_SECONDS]
citekeys [citekeys ...]
Generate bibliographic metadata in CSL JSON format for one or more citation
Expand Down Expand Up @@ -220,6 +224,8 @@ options:
Schema. Skips CSL pruning.
--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
Set the logging level for stderr logging
-t TIMEOUT_SECONDS, --timeout TIMEOUT_SECONDS
timeout for web requests
```

### Pandoc filter
Expand Down Expand Up @@ -273,6 +279,7 @@ The `manubot webpage` command populates a `webpage` directory with Manubot outpu
usage: manubot webpage [-h] [--checkout [CHECKOUT]] [--version VERSION]
[--timestamp] [--no-ots-cache | --ots-cache OTS_CACHE]
[--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
[-t TIMEOUT_SECONDS]
Update the webpage directory tree with Manubot output files. This command
should be run from the root directory of a Manubot manuscript that follows the
Expand Down Expand Up @@ -301,6 +308,8 @@ options:
ci/cache/ots).
--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
Set the logging level for stderr logging
-t TIMEOUT_SECONDS, --timeout TIMEOUT_SECONDS
timeout for web requests
```

## Development
Expand Down
2 changes: 1 addition & 1 deletion manubot/command.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def parse_arguments():
"--timeout",
dest="timeout_seconds",
default=(3, 15),
help="timeout for web requests in seconds",
help="timeout for web requests",
)
args = parser.parse_args()
return args
Expand Down

0 comments on commit 2acc3cf

Please sign in to comment.