From: Daniele Varrazzo <daniele.varrazzo@gmail.com>
Date: Wed, 8 Dec 2021 12:46:26 +0000 (+0100)
Subject: Reword the types package description with more links to relevant docs
X-Git-Tag: pool-3.1~83
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b9813f7153a22864f9e2f687f410a5cb298dde7e;p=thirdparty%2Fpsycopg.git

Reword the types package description with more links to relevant docs
---

diff --git a/docs/api/types.rst b/docs/api/types.rst
index 436e96614..16469e991 100644
--- a/docs/api/types.rst
+++ b/docs/api/types.rst
@@ -7,16 +7,24 @@
 
 .. module:: psycopg.types
 
-The `!psycopg.types` package exposes the concrete implementation of `Loader`
-and `Dumper` to manage builtin objects, together with objects to describe
-PostgreSQL types and wrappers to help or customise the types conversion.
+The `!psycopg.types` package exposes:
+
+- objects to describe PostgreSQL types, such as `TypeInfo`, `TypesRegistry`,
+  to help or :ref:`customise the types conversion <adaptation>`;
+
+- concrete implementations of `~psycopg.abc.Loader` and `~psycopg.abc.Dumper`
+  protocols to :ref:`handle builtin data types <types-adaptation>`;
+
+- helper objects to represent PostgreSQL data types which :ref:`don't have a
+  straightforward Python representation <extra-adaptation>`, such as
+  `~range.Range`.
 
 
 Types information
 -----------------
 
 The `TypeInfo` object describes simple information about a PostgreSQL data
-type, such as its name, oid and array oid. Subclasses may hold more
+type, such as its name, oid and array oid. `!TypeInfo` subclasses may hold more
 information, for instance the components of a composite type.
 
 You can use `TypeInfo.fetch()` to query information from a database catalog,