Re: Conventions

2022-02-02 Thread Bruce Momjian
On Wed, Jan 26, 2022 at 09:51:53PM -0500, Bruce Momjian wrote: > > I'd suggest a separate para at some point before the first usage, > > along the lines of > > > >In this section, we follow the usual Tcl convention of using question > >marks, rather than brackets, to indicate an optional

Re: Conventions

2022-01-26 Thread Bruce Momjian
e will is an illusion. diff --git a/doc/src/sgml/notation.sgml b/doc/src/sgml/notation.sgml index bd1e8f629a..c3798d5f1b 100644 --- a/doc/src/sgml/notation.sgml +++ b/doc/src/sgml/notation.sgml @@ -6,12 +6,12 @@ The following conventions are used in the synopsis of a command: brackets ([ a

Re: Conventions

2022-01-26 Thread Tom Lane
Bruce Momjian writes: > OK, updated patch attached. I don't think we even show TCL syntax > anywhere anymore, so I removed that text, rather than moving it. I really don't care for this phrasing at all: - the body of a PL/Tcl function: + the body of a PL/Tcl function (brackets ([ and +

Re: Conventions

2022-01-26 Thread Bruce Momjian
ttps://enterprisedb.com If only the physical world exists, free will is an illusion. diff --git a/doc/src/sgml/notation.sgml b/doc/src/sgml/notation.sgml index bd1e8f629a..c3798d5f1b 100644 --- a/doc/src/sgml/notation.sgml +++ b/doc/src/sgml/notation.sgml @@ -6,12 +6,12 @@ The following co

Re: Conventions

2022-01-26 Thread Alvaro Herrera
On 2022-Jan-26, Bruce Momjian wrote: > On Tue, Jan 25, 2022 at 06:45:47PM -0800, Dave Stewart wrote: > > I'm good with it.  Thank you! > > OK, updated patch attached. I don't think we even show TCL syntax > anywhere anymore, so I removed that text, rather than moving it. We do here:

Re: Conventions

2022-01-26 Thread Tom Lane
Bruce Momjian writes: > OK, updated patch attached. I don't think we even show TCL syntax > anywhere anymore, so I removed that text, rather than moving it. WFM. regards, tom lane

Re: Conventions

2022-01-26 Thread Bruce Momjian
,12 @@ The following conventions are used in the synopsis of a command: brackets ([ and ]) indicate - optional parts. (In the synopsis of a Tcl command, question marks - (?) are used instead, as is usual in Tcl.) Braces + optional parts. Braces ({ and }) and vertical lines (|) indic

Re: Conventions

2022-01-25 Thread Dave Stewart
I'm good with it. Thank you! On Tue, Jan 25, 2022 at 6:15 PM David G. Johnston < david.g.johns...@gmail.com> wrote: > On Tuesday, January 25, 2022, Tom Lane wrote: > >> Bruce Momjian writes: >> > How is this patch? >> >> I'd still drop the Tcl bit, or if you must have it, move it to >>

Re: Conventions

2022-01-25 Thread David G. Johnston
On Tuesday, January 25, 2022, Tom Lane wrote: > Bruce Momjian writes: > > How is this patch? > > I'd still drop the Tcl bit, or if you must have it, move it to > pltcl.sgml. Otherwise OK by me. > > > Agreed. David J.

Re: Conventions

2022-01-25 Thread Tom Lane
Bruce Momjian writes: > How is this patch? I'd still drop the Tcl bit, or if you must have it, move it to pltcl.sgml. Otherwise OK by me. regards, tom lane

Re: Conventions

2022-01-25 Thread Bruce Momjian
free will is an illusion. diff --git a/doc/src/sgml/notation.sgml b/doc/src/sgml/notation.sgml index bd1e8f629a..c0f41569cb 100644 --- a/doc/src/sgml/notation.sgml +++ b/doc/src/sgml/notation.sgml @@ -6,12 +6,13 @@ The following conventions are used in the synopsis of a command: brackets ([

Re: Conventions

2022-01-25 Thread Tom Lane
"David G. Johnston" writes: > There is an implied "anything else not noted here should be taken as > literal token to type, or a variable, as context dictates" [1] - and since > () isn't mentioned... > I'd probably rather make that implied part explicit and avoid mentioning > parentheses

Re: Conventions

2022-01-25 Thread Dave Stewart
entation comment has been logged on the website: >> > >> > Page: https://www.postgresql.org/docs/12/notation.html >> > Description: >> > >> > In section 3, Conventions, it would be helpful to point out that >> > parentheses, when used

Re: Conventions

2022-01-25 Thread David G. Johnston
ription: > > > > In section 3, Conventions, it would be helpful to point out that > > parentheses, when used in the command descriptions, are to be > interpreted as > > literal required elements. As a newbie, the combination of {}, [], () > was > > a

Re: Conventions

2022-01-25 Thread Bruce Momjian
On Tue, Jan 25, 2022 at 03:31:03AM +, PG Doc comments form wrote: > The following documentation comment has been logged on the website: > > Page: https://www.postgresql.org/docs/12/notation.html > Description: > > In section 3, Conventions, it would be helpful to point out

Conventions

2022-01-25 Thread PG Doc comments form
The following documentation comment has been logged on the website: Page: https://www.postgresql.org/docs/12/notation.html Description: In section 3, Conventions, it would be helpful to point out that parentheses, when used in the command descriptions, are to be interpreted as literal required

Re: conventions

2021-07-07 Thread Euler Taveira
On Wed, Jul 7, 2021, at 1:30 PM, rir wrote: > > The conventions page is weak. Here is a proposed start for > change. Seeing SQL as an early language, I have tried to use something > like plain English. Here "early" could describe a mail merge user > wandering into pro

conventions

2021-07-07 Thread rir
The conventions page is weak. Here is a proposed start for change. Seeing SQL as an early language, I have tried to use something like plain English. Here "early" could describe a mail merge user wandering into programming SQL after seeing some simple examples. I lik

RE: typo in doc for "Miscellaneous Coding Conventions"

2021-05-18 Thread tanghy.f...@fujitsu.com
>"were not" is typical usage when stating a contrary-to-fact hypothetical. > If the implementation (or you) didn’t do X, then Y bad thing could happen. Really thanks for your kindly reply and explain. Please forgive me for my poor English. Anyway, got it. Regards, Tang

Re: typo in doc for "Miscellaneous Coding Conventions"

2021-05-18 Thread Bryn Llewellyn
t...@sss.pgh.pa.us wrote: > PG Doc comments form writes: > >> small fix in description at [1] as follows > >> -If that were not done interrupted code that's currently inspecting errno >> might see the wrong value. >> +If that was not done interrupted code that's currently inspecting errno >>

Re: typo in doc for "Miscellaneous Coding Conventions"

2021-05-18 Thread Tom Lane
PG Doc comments form writes: > small fix in description at [1] as follows > -If that were not done interrupted code that's currently inspecting errno > might see the wrong value. > +If that was not done interrupted code that's currently inspecting errno > might see the wrong value. The existing

typo in doc for "Miscellaneous Coding Conventions"

2021-05-18 Thread PG Doc comments form
The following documentation comment has been logged on the website: Page: https://www.postgresql.org/docs/13/source-conventions.html Description: small fix in description at [1] as follows -If that were not done interrupted code that's currently inspecting errno might see the wrong value. +If