minor doc work

Started by Neil Conwayover 22 years ago3 messagespatches
Jump to latest
#1Neil Conway
neilc@samurai.com

I've applied the two attached minor documentation patches to HEAD.
Each patch makes a few minor improvements to a particular section of
the docs (the discussion of IS NULL and the discussion of SET,
respectively).

Cheers,

Neil

Attachments:

oper_doc_improv-1.patchtext/x-patch; name=oper_doc_improv-1.patchDownload+20-20
runtime_set_docs_improv-1.patchtext/x-patch; name=runtime_set_docs_improv-1.patchDownload+7-7
#2Peter Eisentraut
peter_e@gmx.net
In reply to: Neil Conway (#1)
Re: minor doc work

Neil Conway wrote:

If <command>SET</> is allowed, it overrides all other sources of
! values for the parameter. Superusers are allowed to
! <command>SET</> more values than ordinary users. Some parameters
! cannot be <command>SET</command> even by superusers: for example,

Please don't use marked up command names as verbs. Next week you'll be
<command>UPDATE</command>ing or something. Here, there is no chance for
confusion, so just write "cannot be set" or "cannot be changed with
<command>SET</command>". In fact, the latter is even clearer.

Show quoted text

! if they control behavior that cannot reasonably be changed without
! restarting <productname>PostgreSQL</productname>.

#3Neil Conway
neilc@samurai.com
In reply to: Peter Eisentraut (#2)
Re: minor doc work

Peter Eisentraut <peter_e@gmx.net> writes:

Please don't use marked up command names as verbs. Next week you'll
be <command>UPDATE</command>ing or something.

The existing documentation does this -- indeed, the very section of
the docs that I modified *already* did it:

If <command>SET</> is allowed, it overrides all other sources of
! values for the parameter. Superusers are allowed to <command>SET</>
! more values than ordinary users.

(which was the original text)

I've modified this particular section per your suggestion, but I
haven't made any wider changes (i.e. this style is still used in other
places).

-Neil