docs: document the ALLOCATED ConnStatus value

diff --git a/docs/api/pq.rst b/docs/api/pq.rst
index bbc34f704f66c86a5f238dc2fb75944e2b85bb9e..a0d304c6e3fbd8485afdef77273fa2c7e4f50783 100644 (file)
--- a/docs/api/pq.rst
+++ b/docs/api/pq.rst
@@ -148,6 +148,7 @@ Enumerations
     There are other values in this enum, but only `OK` and `BAD` are seen
     after a connection has been established. Other statuses might only be seen
     during the connection phase and are considered internal.
+    `ALLOCATED` is only expected to be returned by `PGcancelConn.status`.
 
     .. seealso:: :pq:`PQstatus()` and `PQcancelStatus()` return this value.
 

diff --git a/psycopg/psycopg/pq/_enums.py b/psycopg/psycopg/pq/_enums.py
index 1f6fcd48c1021da20852d19f5f0f1fb179827cae..6b03b0621feb18398f79b001a010814bdbbffc9a 100644 (file)
--- a/psycopg/psycopg/pq/_enums.py
+++ b/psycopg/psycopg/pq/_enums.py
@@ -32,6 +32,7 @@ class ConnStatus(IntEnum):
     CHECK_TARGET = auto()
     CHECK_STANDBY = auto()
     ALLOCATED = auto()  # Only for cancel connections.
+    """Connection to the server hasn't been initiated yet."""
 
 
 class PollingStatus(IntEnum):