small doccumentation fix in psql

Started by Dilip kumarover 11 years ago4 messages
#1Dilip kumar
dilip.kumar@huawei.com
1 attachment(s)

Currently \pset is supported without any argument also, so same is updated in documentation.

\pset option [ value ]
Changed to
\pset [ option [ value ] ]

Thanks & Regards,
Dilip Kumar

Attachments:

psql_doc.patchapplication/octet-stream; name=psql_doc.patchDownload
*** a/doc/src/sgml/ref/psql-ref.sgml
--- b/doc/src/sgml/ref/psql-ref.sgml
***************
*** 1943,1949 **** lo_import 152801
        </varlistentry>
  
        <varlistentry>
!         <term><literal>\pset <replaceable class="parameter">option</replaceable> [ <replaceable class="parameter">value</replaceable> ]</literal></term>
  
          <listitem>
          <para>
--- 1943,1949 ----
        </varlistentry>
  
        <varlistentry>
!         <term><literal>\pset [ <replaceable class="parameter">option</replaceable> [ <replaceable class="parameter">value</replaceable> ] ]</literal></term>
  
          <listitem>
          <para>
#2Fabien COELHO
coelho@cri.ensmp.fr
In reply to: Dilip kumar (#1)
Re: small doccumentation fix in psql

Currently \pset is supported without any argument also, so same is updated in documentation.

\pset option [ value ]
Changed to
\pset [ option [ value ] ]

This patch does update the documentation as stated, and make it consistent
with the reality and the embedded psql help. This is an improvement and I
recommand its inclusion.

I would also suggest to move the sentence at the end of the description:

"\pset without any arguments displays the current status of all printing
options."

At then end of the first paragraph, before the detailed description of
options, so as to comment directly on this non mandatory "option".

--
Fabien.

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers

#3Dilip kumar
dilip.kumar@huawei.com
In reply to: Fabien COELHO (#2)
1 attachment(s)
Re: small doccumentation fix in psql

On 21 July 2014 13:39, Fabien COELHO Wrote

This patch does update the documentation as stated, and make it
consistent with the reality and the embedded psql help. This is an
improvement and I recommand its inclusion.

I would also suggest to move the sentence at the end of the description:

"\pset without any arguments displays the current status of all
printing options."

At then end of the first paragraph, before the detailed description of
options, so as to comment directly on this non mandatory "option".

Done.

Regards,
Dilip

Attachments:

psql_doc_v1.patchapplication/octet-stream; name=psql_doc_v1.patchDownload
*** a/doc/src/sgml/ref/psql-ref.sgml
--- b/doc/src/sgml/ref/psql-ref.sgml
***************
*** 1943,1949 **** lo_import 152801
        </varlistentry>
  
        <varlistentry>
!         <term><literal>\pset <replaceable class="parameter">option</replaceable> [ <replaceable class="parameter">value</replaceable> ]</literal></term>
  
          <listitem>
          <para>
--- 1943,1949 ----
        </varlistentry>
  
        <varlistentry>
!         <term><literal>\pset [ <replaceable class="parameter">option</replaceable> [ <replaceable class="parameter">value</replaceable> ] ]</literal></term>
  
          <listitem>
          <para>
***************
*** 1960,1965 **** lo_import 152801
--- 1960,1970 ----
          </para>
  
          <para>
+         <command>\pset</command> without any arguments displays the current status
+         of all printing options.
+         </para>
+ 
+         <para>
          Adjustable printing options are:
          <variablelist>
            <varlistentry>
***************
*** 2298,2308 **** lo_import 152801
          </para>
          </tip>
  
-         <para>
-         <command>\pset</command> without any arguments displays the current status
-         of all printing options.
-         </para>
- 
          </listitem>
        </varlistentry>
  
--- 2303,2308 ----
#4Fabien COELHO
coelho@cri.ensmp.fr
In reply to: Dilip kumar (#3)
Re: small doccumentation fix in psql

This patch does update the documentation as stated, and make it
consistent with the reality and the embedded psql help. This is an
improvement and I recommand its inclusion.

I would also suggest to move the sentence at the end of the description:

"\pset without any arguments displays the current status of all
printing options."

At then end of the first paragraph, before the detailed description of
options, so as to comment directly on this non mandatory "option".

Indeed, the new patch implements the suggestion, and I think this is an
improvement, so I recommand its inclusion.

--
Fabien.

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers