From: James Addison <james@reciperadar.com>
Date: Wed, 26 Apr 2023 20:29:53 +0000 (-0400)
Subject: Followup / fixup: apply 'black' code formatting to a couple of missed docstrings
X-Git-Tag: rel_1_11_0~14
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=abd175bf86b1091fe444b91c4f98dc9ea97ff723;p=thirdparty%2Fsqlalchemy%2Falembic.git

Followup / fixup: apply 'black' code formatting to a couple of missed docstrings

### Description
Follow-up / completion of #1220.  That change updated a number of docstrings within the codebase to use standardised `black` code formatting, but a couple of locations had been missed.

### Checklist

This pull request is:

- [x] A documentation / typographical error fix
	- Good to go, no issue or tests are needed

Closes: #1228
Pull-request: https://github.com/sqlalchemy/alembic/pull/1228
Pull-request-sha: f5696b9ca34998e22af5705434ed2393d86e82c0

Change-Id: I5d935b036d6f4e11eb5c229f9982db587d67ae24
---

diff --git a/alembic/op.pyi b/alembic/op.pyi
index 229fff32..01edb611 100644
--- a/alembic/op.pyi
+++ b/alembic/op.pyi
@@ -667,9 +667,7 @@ def create_primary_key(
 
         from alembic import op
 
-        op.create_primary_key(
-            "pk_my_table", "my_table", ["id", "version"]
-        )
+        op.create_primary_key("pk_my_table", "my_table", ["id", "version"])
 
     This internally generates a :class:`~sqlalchemy.schema.Table` object
     containing the necessary columns, then generates a new
@@ -729,9 +727,10 @@ def create_table(
         from sqlalchemy import Column, TIMESTAMP, func
 
         # specify "DEFAULT NOW" along with the "timestamp" column
-        op.create_table('account',
-            Column('id', INTEGER, primary_key=True),
-            Column('timestamp', TIMESTAMP, server_default=func.now())
+        op.create_table(
+            "account",
+            Column("id", INTEGER, primary_key=True),
+            Column("timestamp", TIMESTAMP, server_default=func.now()),
         )
 
     The function also returns a newly created
diff --git a/alembic/operations/ops.py b/alembic/operations/ops.py
index aab45d4c..f95ab70f 100644
--- a/alembic/operations/ops.py
+++ b/alembic/operations/ops.py
@@ -308,9 +308,7 @@ class CreatePrimaryKeyOp(AddConstraintOp):
 
             from alembic import op
 
-            op.create_primary_key(
-                "pk_my_table", "my_table", ["id", "version"]
-            )
+            op.create_primary_key("pk_my_table", "my_table", ["id", "version"])
 
         This internally generates a :class:`~sqlalchemy.schema.Table` object
         containing the necessary columns, then generates a new
@@ -1214,9 +1212,10 @@ class CreateTableOp(MigrateOperation):
             from sqlalchemy import Column, TIMESTAMP, func
 
             # specify "DEFAULT NOW" along with the "timestamp" column
-            op.create_table('account',
-                Column('id', INTEGER, primary_key=True),
-                Column('timestamp', TIMESTAMP, server_default=func.now())
+            op.create_table(
+                "account",
+                Column("id", INTEGER, primary_key=True),
+                Column("timestamp", TIMESTAMP, server_default=func.now()),
             )
 
         The function also returns a newly created
diff --git a/docs/build/unreleased/1220.rst b/docs/build/unreleased/1220.rst
new file mode 100644
index 00000000..74ecaaf8
--- /dev/null
+++ b/docs/build/unreleased/1220.rst
@@ -0,0 +1,6 @@
+.. change::
+    :tags: misc
+    :tickets: 1220
+
+    Update code snippets within docstrings to use ``black`` code formatting.
+    Pull request courtesy of James Addison.