Document that btrim()'s second parameter is optional, and defaults to spaces.
authorBruce Momjian <bruce@momjian.us>
Thu, 2 Dec 2004 17:14:54 +0000 (17:14 +0000)
committerBruce Momjian <bruce@momjian.us>
Thu, 2 Dec 2004 17:14:54 +0000 (17:14 +0000)
doc/src/sgml/func.sgml

index 4eddc2cd9077a79f121f7e003db614a171726433..3a9add8baa2a2043464a7c6681e464c233d94a32 100644 (file)
@@ -1070,12 +1070,13 @@ PostgreSQL documentation
       </row>
 
       <row>
-       <entry><literal><function>btrim</function>(<parameter>string</parameter> <type>text</type>, <parameter>characters</parameter> <type>text</type>)</literal></entry>
+       <entry><literal><function>btrim</function>(<parameter>string</parameter> <type>text</type>
+       <optional>, <parameter>characters</parameter> <type>text</type></optional>)</literal></entry>
        <entry><type>text</type></entry>
        <entry>
         Remove the longest string consisting only of characters
-        in <parameter>characters</parameter> from the start and end of
-        <parameter>string</parameter>.
+        in <parameter>characters</parameter> (or spaces if not supplied)
+        from the start and end of <parameter>string</parameter>.
        </entry>
        <entry><literal>btrim('xyxtrimyyx', 'xy')</literal></entry>
        <entry><literal>trim</literal></entry>