From: Daniele Varrazzo <daniele.varrazzo@gmail.com>
Date: Wed, 25 Nov 2020 23:52:52 +0000 (+0000)
Subject: Uppercase admonitions in docs
X-Git-Tag: 3.0.dev0~307
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=22d45fd3a5050f818c49bead3480cd57bed5f1dc;p=thirdparty%2Fpsycopg.git

Uppercase admonitions in docs

With the furo theme it's pretty clear that they are at the start of a
sentence.
---

diff --git a/docs/connection.rst b/docs/connection.rst
index bc40a4b78..962b1fe3d 100644
--- a/docs/connection.rst
+++ b/docs/connection.rst
@@ -50,7 +50,7 @@ The `!Connection` class
 
     .. automethod:: close
 
-        .. note:: you can use :ref:`with connect(): ...<with-statement>` to
+        .. note:: You can use :ref:`with connect(): ...<with-statement>` to
             close the connection automatically when the block is exited.
 
     .. autoattribute:: closed
@@ -58,7 +58,7 @@ The `!Connection` class
 
     .. automethod:: cursor
 
-        .. note:: you can use :ref:`with conn.cursor(): ...<with-statement>`
+        .. note:: You can use :ref:`with conn.cursor(): ...<with-statement>`
             to close the cursor automatically when the block is exited.
 
 
@@ -70,7 +70,7 @@ The `!Connection` class
     .. automethod:: rollback()
     .. automethod:: transaction(savepoint_name: Optional[str] = None, force_rollback: bool = False) -> Transaction
 
-        .. note:: it must be called as ``with conn.transaction() as tx: ...``
+        .. note:: It must be called as ``with conn.transaction() as tx: ...``
 
         Inside a transaction block it will not be possible to call `commit()`
         or `rollback()`.
@@ -132,13 +132,13 @@ The `!AsyncConnection` class
     .. automethod:: connect
     .. automethod:: close
 
-        .. note:: you can use ``async with`` to close the connection
+        .. note:: You can use ``async with`` to close the connection
             automatically when the block is exited, but be careful about
             the async quirkness: see :ref:`with-statement` for details.
 
     .. automethod:: cursor
 
-        .. note:: you can use ``async with`` to close the cursor
+        .. note:: You can use ``async with`` to close the cursor
             automatically when the block is exited, but be careful about
             the async quirkness: see :ref:`with-statement` for details.
 
@@ -147,7 +147,7 @@ The `!AsyncConnection` class
 
     .. automethod:: transaction(savepoint_name: Optional[str] = None, force_rollback: bool = False) -> AsyncTransaction
 
-        .. note:: it must be called as ``async with conn.transaction() as tx: ...``.
+        .. note:: It must be called as ``async with conn.transaction() as tx: ...``.
 
     .. automethod:: notifies
     .. automethod:: set_client_encoding
diff --git a/docs/usage.rst b/docs/usage.rst
index 896d1f657..85f3433a9 100644
--- a/docs/usage.rst
+++ b/docs/usage.rst
@@ -431,7 +431,7 @@ transaction, such as :sql:`CREATE DATABASE`, :sql:`VACUUM`, :sql:`CALL` on
 
 .. warning::
 
-    by default even a simple :sql:`SELECT` will start a transaction: in
+    By default even a simple :sql:`SELECT` will start a transaction: in
     long-running programs, if no further action is taken, the session will
     remain *idle in transaction*, an undesirable condition for several
     reasons (locks are held by the session, tables bloat...). For long lived