Updated docs for auth commands (#2156)

Author: sfc-gh-astus

src/snowflake/cli/_plugins/auth/keypair/commands.py

@@ -87,7 +87,7 @@ def setup(
     **options,
 ):
     """
-    Generates the key pair, sets the public key for the user in Snowflake and creates or updates the connection.
+    Generates the key pair, sets the public key for the user in Snowflake, and creates or updates the connection.
     """
     AuthManager().setup(
         connection_name=connection_name,
@@ -106,7 +106,7 @@ def rotate(
     **options,
 ):
     """
-    Rotates the key for the connection. Generates the key pair, sets the public key for the user in Snowflake and creates or updates the connection.
+    Rotates the key for the connection. Generates the key pair, sets the public key for the user in Snowflake, and creates or updates the connection.
     """
     AuthManager().rotate(
         key_length=key_length,
@@ -129,7 +129,7 @@ def remove(
     public_key_property: PublicKeyProperty = typer.Option(
         ...,
         "--key-id",
-        help=f"local path to template directory or URL to git repository with templates.",
+        help=f"Local path to the template directory or a URL to Git repository with templates.",
         show_default=False,
     ),
     **options,

src/snowflake/cli/api/commands/flags.py

@@ -215,7 +215,7 @@ def _password_callback(value: str):
 TokenFilePathOption = typer.Option(
     None,
     "--token-file-path",
-    help="Path to file with an OAuth token that should be used when connecting to Snowflake",
+    help="Path to file with an OAuth token to use when connecting to Snowflake.",
     callback=_connection_callback("token_file_path"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
@@ -325,7 +325,7 @@ def _diag_log_allowlist_path_callback(path: str):
 DiagAllowlistPathOption: Path = typer.Option(
     None,
     "--diag-allowlist-path",
-    help="Path to a JSON file containing allowlist parameters.",
+    help="Path to a JSON file that contains allowlist parameters.",
     callback=_diag_log_allowlist_path_callback,
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,

tests/__snapshots__/test_docs_generation_output.ambr

@@ -75,7 +75,7 @@
     Snowflake private key file path. Overrides the value specified for the connection.
 
   :samp:`--token-file-path {TEXT}`
-    Path to file with an OAuth token that should be used when connecting to Snowflake.
+    Path to file with an OAuth token to use when connecting to Snowflake.
 
   :samp:`--database, --dbname {TEXT}`
     Database to use. Overrides the value specified for the connection.
@@ -102,7 +102,7 @@
     Path for the generated report. Defaults to system temporary directory. Default: <system_temporary_directory>.
 
   :samp:`--diag-allowlist-path {TEXT}`
-    Path to a JSON file containing allowlist parameters.
+    Path to a JSON file that contains allowlist parameters.
 
   :samp:`--format [TABLE|JSON]`
     Specifies the output format. Default: TABLE.