Skip to content

Commit 9185cbd

Browse files
committed
doc string update
1 parent 68aaa36 commit 9185cbd

2 files changed

Lines changed: 5 additions & 6 deletions

File tree

awscrt/aws_iot_metrics.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -414,10 +414,8 @@ def _create_metrics(user_metrics, crt_feature_list):
414414
IoTSDKMetricsVersion, IoTSDKFeature) are passed through unchanged.
415415
416416
Args:
417-
user_metrics : Metrics configuration from
418-
the IoT SDK. May be None if no SDK-level metrics are provided.
419-
crt_feature_list : Encoded CRT feature list string generated
420-
by _get_encoded_feature_list or _get_encoded_feature_list_mqtt3.
417+
user_metrics: Metrics configuration from the IoT SDK. May be None if no SDK-level metrics are provided.
418+
crt_feature_list: Encoded CRT feature list string generated by _get_encoded_feature_list or _get_encoded_feature_list_mqtt3.
421419
Returns:
422420
AWSIoTMetrics: The final metrics object ready to be embedded in the
423421
MQTT CONNECT packet username field.

awscrt/io.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,13 @@ class _CertificateSource(IntEnum):
1919
"""Certificate source types for mTLS authentication.
2020
2121
Used by TlsContextOptions to track which factory method created the
22-
TLS configuration. The CRT reads this and encodes it as
22+
TLS configuration. The metrics reads this and encodes it as
2323
feature ID "I" in the metrics string.
2424
"""
2525
CERTIFICATE_FILES = 0 # PEM cert + key files
2626
PKCS11 = 1 # Hardware security module via PKCS11
27-
WINDOWS_CERT_STORE = 2 # windows certificate source
27+
WINDOWS_CERT_STORE = 2 # Windows certificate source
28+
# 3 is reserved for Java keystore (not applicable to Python)
2829
PKCS12_FILE = 4 # PKCS#12 (.p12/.pfx) files
2930

3031

0 commit comments

Comments
 (0)