From 5ff5fabc2e49039099a23b8f32ceb95d67bcea10 Mon Sep 17 00:00:00 2001 From: harisang Date: Wed, 8 Jan 2025 16:19:25 +0200 Subject: [PATCH] clean up readme --- README.md | 11 ++++------- src/utils/script_args.py | 4 +--- 2 files changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d5c7547b..7178af46 100644 --- a/README.md +++ b/README.md @@ -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 ``` diff --git a/src/utils/script_args.py b/src/utils/script_args.py index 3d77500d..5e791403 100644 --- a/src/utils/script_args.py +++ b/src/utils/script_args.py @@ -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",