public inbox for [email protected]  

help / color / mirror / Atom feed

From: Alvaro Herrera <[email protected]>
To: Pg Docs <[email protected]>
Subject: psql's \h MOVE
Date: Fri, 01 Apr 2011 12:17:18 -0300
Message-ID: <[email protected]> (raw)

I just noticed that \h MOVE is particularly unhelpful:

	alvherre=# \h move
	Command:     MOVE
	Description: position a cursor
	Syntax:
	MOVE [ direction { FROM | IN } ] cursorname


The problem is that it doesn't specify what "direction" is.  The doc
text tells you to look into FETCH for details, but in \h you have to
guess.

We could fix this by including a note about fetch in the <synopsis>,
so that it'd look like this:

	alvherre=# \h move
	Command:     MOVE
	Description: position a cursor
	Syntax:
	MOVE [ direction [ FROM | IN ] ] cursor_name

	See FETCH for details on direction

This, of course, also appears in the HTML output.

This requires this simple patch:

--- a/doc/src/sgml/ref/move.sgml
+++ b/doc/src/sgml/ref/move.sgml
@@ -27,6 +27,8 @@ PostgreSQL documentation
  <refsynopsisdiv>
 <synopsis>
 MOVE [ <replaceable class="PARAMETER">direction</replaceable> [ FROM | IN ] ] <replaceable class="PARAMETER">cursor_name</replaceable>
+
+<phrase>See <command>FETCH</command> for details on <replaceable class="PARAMETER">direction</replaceable>.</phrase>
 </synopsis>
  </refsynopsisdiv>


Would anybody object to doing things this way?

The alternative I see is to expand the "direction" in the MOVE synopsis,
but it is repetitive and would require more maintenance should we ever
decide to change the possible directions.

-- 
Álvaro Herrera <[email protected]>

view thread (4+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected]
  Subject: Re: psql's \h MOVE
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox