Skip to content

Commit 915066e

Browse files
committed
add metavars for a bunch of arguments for nicer docs
1 parent 6be3969 commit 915066e

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

meshtastic/__main__.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1290,6 +1290,7 @@ def addSelectionArgs(parser: argparse.ArgumentParser) -> argparse.ArgumentParser
12901290
"--ch-index",
12911291
help="Set the specified channel index for channel-specific commands. Channels start at 0 (0 is the PRIMARY channel).",
12921292
action="store",
1293+
metavar="INDEX",
12931294
)
12941295

12951296
return parser
@@ -1329,13 +1330,15 @@ def addConfigArgs(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
13291330
),
13301331
nargs=1,
13311332
action="append",
1333+
metavar="FIELD"
13321334
)
13331335

13341336
group.add_argument(
13351337
"--set",
13361338
help="Set a preferences field. Can use either snake_case or camelCase format. (ex: 'ls_secs' or 'lsSecs')",
13371339
nargs=2,
13381340
action="append",
1341+
metavar=("FIELD", "VALUE"),
13391342
)
13401343

13411344
group.add_argument(
@@ -1370,6 +1373,7 @@ def addConfigArgs(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
13701373
"--set-ringtone",
13711374
help="Set the Notification Ringtone (up to 230 characters).",
13721375
action="store",
1376+
metavar="RINGTONE",
13731377
)
13741378

13751379
group.add_argument(
@@ -1457,13 +1461,15 @@ def addChannelConfigArgs(parser: argparse.ArgumentParser) -> argparse.ArgumentPa
14571461
),
14581462
nargs=2,
14591463
action="append",
1464+
metavar=("FIELD", "VALUE"),
14601465
)
14611466

14621467
group.add_argument(
14631468
"--channel-fetch-attempts",
14641469
help=("Attempt to retrieve channel settings for --ch-set this many times before giving up. Default %(default)s."),
14651470
default=3,
14661471
type=int,
1472+
metavar="ATTEMPTS",
14671473
)
14681474

14691475
group.add_argument(
@@ -1572,14 +1578,16 @@ def addRemoteActionArgs(parser: argparse.ArgumentParser) -> argparse.ArgumentPar
15721578
group.add_argument(
15731579
"--sendtext",
15741580
help="Send a text message. Can specify a destination '--dest' and/or channel index '--ch-index'.",
1581+
metavar="TEXT",
15751582
)
15761583

15771584
group.add_argument(
15781585
"--traceroute",
15791586
help="Traceroute from connected node to a destination. "
15801587
"You need pass the destination ID as argument, like "
15811588
"this: '--traceroute !ba4bf9d0' "
1582-
"Only nodes that have the encryption key can be traced.",
1589+
"Only nodes with a shared channel can be traced.",
1590+
metavar="!xxxxxxxx",
15831591
)
15841592

15851593
group.add_argument(

0 commit comments

Comments
 (0)