Skip to content

Commit 1a50199

Browse files
xiazhveraxiazhvera
authored
improve naming convention (#646)
1 parent bd849dd commit 1a50199

File tree

15 files changed

+30
-30
lines changed

15 files changed

+30
-30
lines changed

‎documents/FAQ.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Here is an example launch.json file to run the pubsub sample
108108
"--ca_file", "<path to root-CA>",
109109
"--cert", "<path to cert>",
110110
"--key", "<path to key>",
111-
"--client-id", "test-client"
111+
"--client_id", "test-client"
112112
]
113113
}
114114
]

‎samples/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ required arguments:
7171
--key Path to the private key file to use during mTLS connection establishment (default: None)
7272
7373
optional arguments:
74-
--client-id Client ID (default: mqtt5-sample-5873a450)
74+
--client_id Client ID (default: mqtt5-sample-5873a450)
7575
--ca_file Path to optional CA bundle (PEM) (default: None)
7676
--topic Topic (default: test/topic)
7777
--message Message payload (default: Hello from mqtt5 sample)

‎samples/greengrass/basic_discovery.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@
4242
help="(optional, default='False').")
4343
optional.add_argument("--mode", default='both', metavar="", dest="input_mode",
4444
help=f"The operation mode (optional, default='both').\nModes:{allowed_actions}")
45-
optional.add_argument("--proxy-host", metavar="", dest="input_proxy_host",
45+
optional.add_argument("--proxy_host", metavar="", dest="input_proxy_host",
4646
help="HTTP proxy host")
47-
optional.add_argument("--proxy-port", type=int, default=0, metavar="", dest="input_proxy_port",
47+
optional.add_argument("--proxy_port", type=int, default=0, metavar="", dest="input_proxy_port",
4848
help="HTTP proxy port")
49-
optional.add_argument("--client-id", metavar="", dest="input_clientId", default=f"mqtt5-sample-{uuid.uuid4().hex[:8]}",
49+
optional.add_argument("--client_id", metavar="", dest="input_clientId", default=f"mqtt5-sample-{uuid.uuid4().hex[:8]}",
5050
help="Client ID")
5151

5252
# args contains all the parsed commandline arguments used by the sample

‎samples/mqtt/mqtt5_aws_websocket.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ To Run this sample from the `samples\mqtt` folder, use the following command:
7272
# For Windows: replace 'python3' with 'python' and '/' with '\'
7373
python3 mqtt5_aws_websocket.py \
7474
--endpoint <AWS IoT endpoint> \
75-
--signing-region <Signing region for websocket connection>
75+
--signing_region <Signing region for websocket connection>
7676
```
7777
If you would like to see what optional arguments are available, use the `--help` argument:
7878
``` sh
@@ -89,10 +89,10 @@ options:
8989
9090
required arguments:
9191
--endpoint IoT endpoint hostname (default: None)
92-
--signing-region Signing region for websocket connection (default: None)
92+
--signing_region Signing region for websocket connection (default: None)
9393
9494
optional arguments:
95-
--client-id Client ID (default: mqtt5-sample-809571c8)
95+
--client_id Client ID (default: mqtt5-sample-809571c8)
9696
--ca_file Path to optional CA bundle (PEM) (default: None)
9797
--topic Topic (default: test/topic)
9898
--message Message payload (default: Hello from mqtt5 sample)

‎samples/mqtt/mqtt5_aws_websocket.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
# Required Arguments
1919
required.add_argument("--endpoint", required=True, metavar="", dest="input_endpoint",
2020
help="IoT endpoint hostname")
21-
required.add_argument("--signing-region", required=True, metavar="", dest="input_signing_region",
21+
required.add_argument("--signing_region", required=True, metavar="", dest="input_signing_region",
2222
help="Signing region for websocket connection")
2323

2424
# Optional Arguments
25-
optional.add_argument("--client-id", metavar="", dest="input_clientId", default=f"mqtt5-sample-{uuid.uuid4().hex[:8]}",
25+
optional.add_argument("--client_id", metavar="", dest="input_clientId", default=f"mqtt5-sample-{uuid.uuid4().hex[:8]}",
2626
help="Client ID")
2727
optional.add_argument("--ca_file", metavar="", dest="input_ca",
2828
help="Path to optional CA bundle (PEM)")

‎samples/mqtt/mqtt5_custom_auth.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ required arguments:
121121
--auth_password The password to send when connecting through a custom authorizer (optional) (default: None)
122122
123123
optional arguments:
124-
--client-id Client ID (default: test-f3168b42)
124+
--client_id Client ID (default: test-f3168b42)
125125
--topic Topic (default: test/topic)
126126
--message Message payload (default: Hello from mqtt5 sample)
127127
--count Messages to publish (0 = infinite) (default: 5)

‎samples/mqtt/mqtt5_custom_auth_signed.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
help="The password to send when connecting through a custom authorizer (optional)")
3434

3535
# Optional Arguments
36-
optional.add_argument("--client-id", metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}",
36+
optional.add_argument("--client_id", metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}",
3737
help="Client ID")
3838
optional.add_argument("--topic", default="test/topic", metavar="", dest="input_topic",
3939
help="Topic")

‎samples/mqtt/mqtt5_custom_auth_unsigned.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
help="The password to send when connecting through a custom authorizer")
2727

2828
# Optional Arguments
29-
optional.add_argument("--client-id", metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}",
29+
optional.add_argument("--client_id", metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}",
3030
help="Client ID")
3131
optional.add_argument("--topic", default="test/topic", metavar="", dest="input_topic",
3232
help="Topic")

‎samples/mqtt/mqtt5_pkcs11_connect.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ optional arguments:
109109
--topic Topic (default: test/topic)
110110
--message Message payload (default: Hello from mqtt5 sample)
111111
--count Messages to publish (0 = infinite) (default: 5)
112-
--proxy-host HTTP proxy host (default: None)
113-
--proxy-port HTTP proxy port (default: 0)
114-
--client-id Client ID (default: test-548e4344)
112+
--proxy_host HTTP proxy host (default: None)
113+
--proxy_port HTTP proxy port (default: 0)
114+
--client_id Client ID (default: test-548e4344)
115115
```
116116

117117
### Run sample with SoftHSM

‎samples/mqtt/mqtt5_pkcs11_connect.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@
4242
help="Message payload")
4343
optional.add_argument("--count", type=int, default=5, metavar="", dest="input_count",
4444
help="Messages to publish (0 = infinite)")
45-
optional.add_argument("--proxy-host", metavar="", dest="input_proxy_host",
45+
optional.add_argument("--proxy_host", metavar="", dest="input_proxy_host",
4646
help="HTTP proxy host")
47-
optional.add_argument("--proxy-port", type=int, default=0, metavar="", dest="input_proxy_port",
47+
optional.add_argument("--proxy_port", type=int, default=0, metavar="", dest="input_proxy_port",
4848
help="HTTP proxy port")
49-
optional.add_argument("--client-id", metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}",
49+
optional.add_argument("--client_id", metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}",
5050
help="Client ID")
5151

5252
# args contains all the parsed commandline arguments used by the sample

0 commit comments

Comments
 (0)