Consistently document the using parameter

Author: Photonios

docs/source/table_partitioning.rst

@@ -101,7 +101,7 @@ Command-line options
   Long flag            Short flag    Default          Description
  ==================== ============= ================ ==================================================================================================== === === === === === ===
   ``--yes``            ``-y``        ``False``        Specifies yes to all questions. You will NOT be asked for confirmation before partition deletion.
-  ``--using``          ``-u``        ``'default'``    Name of the database connection to use.
+  ``--using``          ``-u``        ``'default'``    Optional name of the database connection to use.
   ``--skip-create``                  ``False``        Whether to skip creating partitions.
   ``--skip-delete``                  ``False``        Whether to skip deleting partitions.
 

psqlextra/locking.py

@@ -45,7 +45,7 @@ def postgres_lock_table(
             using it's ``search_path``.
 
         using:
-            Name of the database alias to use.
+            Optional name of the database connection to use.
     """
 
     connection = connections[using]
@@ -89,7 +89,7 @@ def postgres_lock_model(
             this unless you're doing something special.
 
         using:
-            Name of the database alias to use.
+            Optional name of the database connection to use.
     """
 
     postgres_lock_table(

psqlextra/management/commands/pgpartition.py

@@ -37,7 +37,7 @@ def add_arguments(self, parser):
         parser.add_argument(
             "--using",
             "-u",
-            help="Name of the database connection to use.",
+            help="Optional name of the database connection to use.",
             default="default",
         )
 

psqlextra/partitioning/manager.py

@@ -39,7 +39,7 @@ def plan(
                 for deletion, regardless of the configuration.
 
             using:
-                Name of the database connection to use.
+                Optional name of the database connection to use.
 
         Returns:
             A plan describing what partitions would be created

psqlextra/partitioning/plan.py

@@ -28,7 +28,7 @@ def apply(self, using: Optional[str]) -> None:
 
         Arguments:
             using:
-                Name of the database connection to use.
+                Optional name of the database connection to use.
         """
 
         connection = connections[using or "default"]

psqlextra/query.py

@@ -131,7 +131,7 @@ def bulk_insert(
                 just dicts.
 
             using:
-                Name of the database connection to use for
+                Optional name of the database connection to use for
                 this query.
 
         Returns: