SNOW-2183023: comments cleanup

Author: sfc-gh-fpawlowski

src/snowflake/connector/_aws_sign_v4.py

@@ -33,11 +33,11 @@ def sign_get_caller_identity(
     session_token: str | None = None,
 ) -> dict[str, str]:
     """
-    Return the SigV4 headers needed for a presigned **POST** to AWS STS
+    Return the SigV4 headers needed for a presigned POST to AWS STS
     `GetCallerIdentity`.
 
-    Parameters
-    ----------
+    Parameters:
+
     url
         The full STS endpoint with query parameters
         (e.g. ``https://sts.amazonaws.com/?Action=GetCallerIdentity&Version=2011-06-15``)

src/snowflake/connector/wif_util.py

@@ -3,9 +3,9 @@
 """Workload‑identity attestation helpers.
 
 This module builds the attestation token that the Snowflake Python connector
-sends when Authenticating with *Workload Identity Federation* (WIF).
-It supports AWS, Azure, GCP and generic OIDC environments **without** pulling
-in heavy SDKs such as *botocore* – we only need a small presigned STS request
+sends when Authenticating with Workload Identity Federation (WIF).
+It supports AWS, Azure, GCP and generic OIDC environments without pulling
+in heavy SDKs such as botocore – we only need a small presigned STS request
 for AWS and a couple of metadata‑server calls for Azure / GCP.
 """
 
@@ -66,7 +66,7 @@ def from_string(provider: str) -> AttestationProvider:
 @dataclass
 class WorkloadIdentityAttestation:
     provider: AttestationProvider
-    credential: str  # **base64** JSON blob – provider‑specific
+    credential: str  # base64 JSON blob – provider‑specific
     user_identifier_components: dict[str, Any]
 
 
@@ -136,7 +136,7 @@ def _partition_from_region(region: str) -> AWSPartition:
 
 def _sts_host_from_region(region: str) -> str | None:
     """
-    Construct the STS endpoint hostname for *region* according to the
+    Construct the STS endpoint hostname for region according to the
     regionalised-STS rules published by AWS.:contentReference[oaicite:2]{index=2}
 
     References:
@@ -173,8 +173,8 @@ def _try_get_arn_from_env_vars() -> str | None:
 def try_compose_aws_user_identifier(region: str | None = None) -> dict[str, str]:
     """Return an identifier for the running AWS workload.
 
-    Always includes the AWS *region*; adds an *arn* key only if one is already
-    discoverable via common environment variables.  Returns **{}** only if
+    Always includes the AWS region; adds an *arn* key only if one is already
+    discoverable via common environment variables.  Returns {} only if
     the region cannot be determined."""
     region = region or get_region()
     if not region:
@@ -189,7 +189,7 @@ def try_compose_aws_user_identifier(region: str | None = None) -> dict[str, str]
 
 
 def create_aws_attestation() -> WorkloadIdentityAttestation | None:
-    """Return AWS attestation or *None* if we're not on AWS / creds missing."""
+    """Return AWS attestation or None if we're not on AWS / creds missing."""
 
     creds = load_default_credentials()
     if not creds:

test/unit/test_boto_compatibility.py

@@ -119,7 +119,7 @@ def test_sts_host_from_region_matches_botocore(
 ):
     sf_host = _sts_host_from_region(region)
 
-    # Force botocore into **regional** mode so that it doesn’t fall back to the
+    # Force botocore into regional mode so that it doesn’t fall back to the
     # legacy global host (sts.amazonaws.com) for the particular regions (like us-east-1).
     # Both approaches work correctly.
     monkeypatch.setenv("AWS_STS_REGIONAL_ENDPOINTS", "regional")