diff options
author | MarcoFalke <falke.marco@gmail.com> | 2018-11-06 10:44:39 -0500 |
---|---|---|
committer | MarcoFalke <falke.marco@gmail.com> | 2018-11-06 10:44:40 -0500 |
commit | 6af27b81572b7b8e08ebcfe7eb533f40c66be4af (patch) | |
tree | 9da1e6715b51ebf8da85c697541707a9bbcb92c0 /test/functional | |
parent | 880bc728b43f1ea3df690512087590270cf35601 (diff) | |
parent | 5a05aa2db20324892be5e2a54181d106a7bfda46 (diff) |
Merge #14619: tests: Fix value display name in test_runner help text
5a05aa2db2 Add metavar to match var name in help text + Change wording for better readability (Martin Erlandsson)
Pull request description:
The help text given by `test/functional/test_runner.py -h` refers to the value `n`, which is defined as `COMBINEDLOGSLEN` in the list of commands.
To make the help text consistent, this PR changes the display name `COMBINEDLOGSLEN` to `n` by setting the argparse [`metavar`](https://docs.python.org/3/library/argparse.html#metavar) attribute. (`metavar` only changes the _displayed_ name)
Alternatively: Do the opposite and change the help text to use `COMBINEDLOGSLEN`.
---
Before PR:
```
➜ bitcoin > test/functional/test_runner.py -h | grep -A 1 combinedlogslen
--combinedlogslen COMBINEDLOGSLEN, -c COMBINEDLOGSLEN
print a combined log (of length n lines) from all test nodes and test framework to the console on failure.
```
After PR:
```
➜ bitcoin > test/functional/test_runner.py -h | grep -A 1 combinedlogslen
--combinedlogslen n, -c n
print a combined log (of length n lines) from all test nodes and test frameworks to the console on failure.
```
---
Also, fixed pluralization typo.
Tree-SHA512: a1124a4976d29fae1e8ecd7fa2ac523b7f05d541c611166532f44692995691a96faf797fa71582d78634f328b500cbee49c6ef296c8f1a898a57c050cc4e721d
Diffstat (limited to 'test/functional')
-rwxr-xr-x | test/functional/test_runner.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/test/functional/test_runner.py b/test/functional/test_runner.py index 5b2910fb0d..b4fd828142 100755 --- a/test/functional/test_runner.py +++ b/test/functional/test_runner.py @@ -212,7 +212,7 @@ def main(): epilog=''' Help text and arguments for individual test script:''', formatter_class=argparse.RawTextHelpFormatter) - parser.add_argument('--combinedlogslen', '-c', type=int, default=0, help='print a combined log (of length n lines) from all test nodes and test framework to the console on failure.') + parser.add_argument('--combinedlogslen', '-c', type=int, default=0, metavar='n', help='On failure, print a log (of length n lines) to the console, combined from the test framework and all test nodes.') parser.add_argument('--coverage', action='store_true', help='generate a basic coverage report for the RPC interface') parser.add_argument('--ci', action='store_true', help='Run checks and code that are usually only enabled in a continuous integration environment') parser.add_argument('--exclude', '-x', help='specify a comma-separated-list of scripts to exclude.') |