From 750d9171f6f758e9aa30b905c884d53da15a0b87 Mon Sep 17 00:00:00 2001
From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Fri, 28 Jan 2005 23:12:59 +0000
Subject: [PATCH] Add documentation for format_type(), which somehow escaped it
 before.

---
 doc/src/sgml/func.sgml | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 05d661fc247..099f2c4ae90 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.236 2005/01/26 20:42:19 tgl Exp $
+$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.237 2005/01/28 23:12:59 tgl Exp $
 PostgreSQL documentation
 -->
 
@@ -8505,6 +8505,10 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
     this way &mdash; if the name can be recognized at all, it must be visible.
    </para>
 
+   <indexterm zone="functions-info">
+    <primary>format_type</primary>
+   </indexterm>
+
    <indexterm zone="functions-info">
     <primary>pg_get_viewdef</primary>
    </indexterm>
@@ -8554,6 +8558,11 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
      </thead>
 
      <tbody>
+      <row>
+       <entry><literal><function>format_type</function>(<parameter>type_oid</parameter>, <parameter>typemod</>)</literal></entry>
+       <entry><type>text</type></entry>
+       <entry>get SQL name of a data type</entry>
+      </row>
       <row>
        <entry><literal><function>pg_get_viewdef</function>(<parameter>view_name</parameter>)</literal></entry>
        <entry><type>text</type></entry>
@@ -8643,6 +8652,12 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
     </tgroup>
    </table>
 
+  <para>
+   <function>format_type</function> returns the SQL name of a data type that
+   is identified by its type OID and possibly a type modifier.  Pass NULL
+   for the type modifier if no specific modifier is known.
+  </para>
+
   <para>
    <function>pg_get_viewdef</function>,
    <function>pg_get_ruledef</function>,
-- 
GitLab