diff options
| author | James Addison <james@reciperadar.com> | 2023-04-26 16:29:53 -0400 |
|---|---|---|
| committer | Federico Caselli <cfederico87@gmail.com> | 2023-04-26 22:32:02 +0200 |
| commit | abd175bf86b1091fe444b91c4f98dc9ea97ff723 (patch) | |
| tree | 6b5a7bf7a8d7133351acecad9c9a9083b839c3ba | |
| parent | 84462eee9b742e58e0f1937f17820e946508b4e3 (diff) | |
| download | alembic-abd175bf86b1091fe444b91c4f98dc9ea97ff723.tar.gz | |
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
| -rw-r--r-- | alembic/op.pyi | 11 | ||||
| -rw-r--r-- | alembic/operations/ops.py | 11 | ||||
| -rw-r--r-- | docs/build/unreleased/1220.rst | 6 |
3 files changed, 16 insertions, 12 deletions
diff --git a/alembic/op.pyi b/alembic/op.pyi index 229fff3..01edb61 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 aab45d4..f95ab70 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 0000000..74ecaaf --- /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. |