Fix docstrings

Author: YuriiMotov

scripts/docs.py

@@ -99,13 +99,7 @@ def verify_readme() -> None:
 @app.command()
 def live(dirty: bool = False) -> None:
     """
-    Serve with livereload a docs site for a specific language.
-
-    This only shows the actual translated files, not the placeholders created with
-    build-all.
-
-    Takes an optional LANG argument with the name of the language to serve, by default
-    en.
+    Serve the docs site with livereload, at http://127.0.0.1:8008.
     """
     # Enable line numbers during local development to make it easier to highlight
     args = ["zensical", "serve", "--dev-addr", "127.0.0.1:8008"]

sqlmodel/_compat.py

@@ -184,7 +184,7 @@ def get_sa_type_from_type_annotation(annotation: Any) -> Any:
         bases = get_args(annotation)
         if len(bases) > 2:
             raise ValueError("Cannot have a (non-optional) union as a SQLAlchemy field")
-        # Non optional unions are not allowed
+        # Non-optional unions are not allowed
         if bases[0] is not NoneType and bases[1] is not NoneType:
             raise ValueError("Cannot have a (non-optional) union as a SQLAlchemy field")
         # Optional unions are allowed

sqlmodel/ext/asyncio/session.py

@@ -105,7 +105,7 @@ async def exec(
         🚨 You probably want to use `session.exec()` instead of `session.execute()`.
 
         This is the original SQLAlchemy `session.execute()` method that returns objects
-        of type `Row`, and that you have to call `scalars()` to get the model objects.
+        of type `Row`, on which you have to call `scalars()` to get the model objects.
 
         For example:
 
@@ -114,7 +114,7 @@ async def exec(
         heroes = result.scalars().all()
         ```
 
-        instead you could use `exec()`:
+        Instead, you could use `exec()`:
 
         ```Python
         result = await session.exec(select(Hero))
@@ -136,7 +136,7 @@ async def execute(
         🚨 You probably want to use `session.exec()` instead of `session.execute()`.
 
         This is the original SQLAlchemy `session.execute()` method that returns objects
-        of type `Row`, and that you have to call `scalars()` to get the model objects.
+        of type `Row`, on which you have to call `scalars()` to get the model objects.
 
         For example:
 
@@ -145,7 +145,7 @@ async def execute(
         heroes = result.scalars().all()
         ```
 
-        instead you could use `exec()`:
+        Instead, you could use `exec()`:
 
         ```Python
         result = await session.exec(select(Hero))

sqlmodel/main.py

@@ -1006,6 +1006,6 @@ def sqlmodel_update(
         else:
             raise ValueError(
                 "Can't use sqlmodel_update() with something that "
-                f"is not a dict or SQLModel or Pydantic model: {obj}"
+                f"is not a dict, SQLModel, or Pydantic model: {obj}"
             )
         return self

sqlmodel/orm/session.py

@@ -89,15 +89,15 @@ def exec(
         🚨 You probably want to use `session.exec()` instead of `session.execute()`.
 
         This is the original SQLAlchemy `session.execute()` method that returns objects
-        of type `Row`, and that you have to call `scalars()` to get the model objects.
+        of type `Row`, on which you have to call `scalars()` to get the model objects.
 
         For example:
 
         ```Python
         heroes = session.execute(select(Hero)).scalars().all()
         ```
 
-        instead you could use `exec()`:
+        Instead, you could use `exec()`:
 
         ```Python
         heroes = session.exec(select(Hero)).all()
@@ -119,15 +119,15 @@ def execute(
         🚨 You probably want to use `session.exec()` instead of `session.execute()`.
 
         This is the original SQLAlchemy `session.execute()` method that returns objects
-        of type `Row`, and that you have to call `scalars()` to get the model objects.
+        of type `Row`, on which you have to call `scalars()` to get the model objects.
 
         For example:
 
         ```Python
         heroes = session.execute(select(Hero)).scalars().all()
         ```
 
-        instead you could use `exec()`:
+        Instead, you could use `exec()`:
 
         ```Python
         heroes = session.exec(select(Hero)).all()
@@ -146,10 +146,10 @@ def execute(
         """
         🚨 You probably want to use `session.exec()` instead of `session.query()`.
 
-        `session.exec()` is SQLModel's own short version with increased type
+        `session.exec()` is SQLModel's own short version with improved type
         annotations.
 
-        Or otherwise you might want to use `session.execute()` instead of
+        Otherwise, you might want to use `session.execute()` instead of
         `session.query()`.
         """
     )
@@ -159,10 +159,10 @@ def query(  # type: ignore
         """
         🚨 You probably want to use `session.exec()` instead of `session.query()`.
 
-        `session.exec()` is SQLModel's own short version with increased type
+        `session.exec()` is SQLModel's own short version with improved type
         annotations.
 
-        Or otherwise you might want to use `session.execute()` instead of
+        Otherwise, you might want to use `session.execute()` instead of
         `session.query()`.
         """
         return super().query(*entities, **kwargs)