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.

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

Clean up readme #484

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,17 +74,14 @@ looking at the script help menu can help provide a list of options!
```shell
$ python -m src.fetch.transfer_file --help

usage: Fetch Complete Reimbursement [-h] [--start START] [--post-tx POST_TX] [--consolidate-transfers CONSOLIDATE_TRANSFERS] [--dry-run DRY_RUN]
usage: Fetch Complete Reimbursement [-h] [--start START] [--post-tx] [--dry-run]

options:
-h, --help show this help message and exit
--start START Accounting Period Start. Defaults to previous Tuesday
--post-tx POST_TX Flag indicating whether multisend should be posted to safe (requires valid env var `PROPOSER_PK`)
--consolidate-transfers CONSOLIDATE_TRANSFERS
Flag to indicate whether payout transfer file should be optimized (i.e. squash transfers having same receiver-token pair)
--dry-run DRY_RUN Flag indicating whether script should not post alerts or transactions. Only relevant in combination with --post-tx TruePrimarily intended for
deployment in staging environment.
--ignore-slippage IGNORE_SLIPPAGE
--post-tx Flag indicating whether multisend should be posted to safe (requires valid env var `PROPOSER_PK`)
--dry-run Flag indicating whether script should not post alerts or transactions.
--ignore-slippage
Ignore slippage computations
```

Expand Down
4 changes: 1 addition & 3 deletions src/utils/script_args.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,7 @@ def generic_script_init(description: str) -> ScriptArgs:
parser.add_argument(
"--dry-run",
action="store_true",
help="Flag indicating whether script should not post alerts or transactions. "
"Only relevant in combination with --post-tx"
"Primarily intended for deployment in staging environment.",
help="Flag indicating whether script should not post alerts or transactions. ",
)
parser.add_argument(
"--ignore-slippage",
Expand Down
Loading