Deploying to master from @ psycopg/psycopg-website@bc1ad59 🚀

psycopg · May 15, 2024 · dfce800 · dfce800
1 parent 8dac290
commit dfce800
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 9 deletions.
diff --git a/psycopg3/docs/_sources/api/objects.rst.txt b/psycopg3/docs/_sources/api/objects.rst.txt
@@ -176,6 +176,10 @@ The description `Column` object
 
     .. autoattribute:: name
     .. autoattribute:: type_code
+    .. autoattribute:: type_display
+
+        .. versionadded:: 3.2
+
     .. autoattribute:: display_size
     .. autoattribute:: internal_size
     .. autoattribute:: precision

diff --git a/psycopg3/docs/api/objects.html b/psycopg3/docs/api/objects.html
@@ -559,10 +559,22 @@ <h2>The description <a class="reference internal" href="#psycopg.Column" title="
 <dd><p>The numeric OID of the column.</p>
 </dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="psycopg.Column.type_display">
+<span class="sig-name descname"><span class="pre">type_display</span></span><a class="headerlink" href="#psycopg.Column.type_display" title="Permalink to this definition">#</a></dt>
+<dd><p>A pretty representation of the column type.</p>
+<p>It is composed by the type name, followed by eventual modifiers and
+brackets to signify arrays, e.g. <code class="sql docutils literal notranslate"><span class="pre">text</span></code>, <code class="sql docutils literal notranslate"><span class="pre">varchar(42)</span></code>,
+<code class="sql docutils literal notranslate"><span class="pre">date[]</span></code>.</p>
+<div class="versionadded">
+<p><span class="versionmodified added">New in version 3.2.</span></p>
+</div>
+</dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="psycopg.Column.display_size">
 <span class="sig-name descname"><span class="pre">display_size</span></span><a class="headerlink" href="#psycopg.Column.display_size" title="Permalink to this definition">#</a></dt>
-<dd><p>The field size, for <code class="sql docutils literal notranslate"><span class="pre">varchar(n)</span></code>, None otherwise.</p>
+<dd><p>The field size, for string types such as <code class="sql docutils literal notranslate"><span class="pre">varchar(n)</span></code>.</p>
 </dd></dl>
 
 <dl class="py attribute">
@@ -885,6 +897,7 @@ <h2>Two-Phase Commit related objects<a class="headerlink" href="#two-phase-commi
 <li><a class="reference internal" href="#psycopg.Column"><code class="docutils literal notranslate"><span class="pre">Column</span></code></a><ul>
 <li><a class="reference internal" href="#psycopg.Column.name"><code class="docutils literal notranslate"><span class="pre">Column.name</span></code></a></li>
 <li><a class="reference internal" href="#psycopg.Column.type_code"><code class="docutils literal notranslate"><span class="pre">Column.type_code</span></code></a></li>
+<li><a class="reference internal" href="#psycopg.Column.type_display"><code class="docutils literal notranslate"><span class="pre">Column.type_display</span></code></a></li>
 <li><a class="reference internal" href="#psycopg.Column.display_size"><code class="docutils literal notranslate"><span class="pre">Column.display_size</span></code></a></li>
 <li><a class="reference internal" href="#psycopg.Column.internal_size"><code class="docutils literal notranslate"><span class="pre">Column.internal_size</span></code></a></li>
 <li><a class="reference internal" href="#psycopg.Column.precision"><code class="docutils literal notranslate"><span class="pre">Column.precision</span></code></a></li>