Re: documentation structure
От
Corey Huinker
Тема
Re: documentation structure
Дата
Msg-id
CADkLM=dKrJdGt0mNMNA=P4a9C9dY-zy3h+xAX8SZ1G4yzVSMsQ@mail.gmail.com
Ответ на
Re: documentation structure (Dagfinn Ilmari Mannsåker)
Список
Дерево обсуждения
documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Laurenz Albe <laurenz.albe@cybertec.at>
Re: documentation structure Tom Lane <tgl@sss.pgh.pa.us>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Daniel Gustafsson <daniel@yesql.se>
Re: documentation structure Tom Lane <tgl@sss.pgh.pa.us>
Re: documentation structure Peter Eisentraut <peter@eisentraut.org>
Re: documentation structure Daniel Gustafsson <daniel@yesql.se>
Re: documentation structure Bruce Momjian <bruce@momjian.us>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Andrew Dunstan <andrew@dunslane.net>
Re: documentation structure Andres Freund <andres@anarazel.de>
Re: documentation structure Tom Lane <tgl@sss.pgh.pa.us>
Re: documentation structure Andres Freund <andres@anarazel.de>
Re: documentation structure Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
Re: documentation structure Andres Freund <andres@anarazel.de>
Re: documentation structure Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
Re: documentation structure jian he <jian.universality@gmail.com>
Re: documentation structure Corey Huinker <corey.huinker@gmail.com>
Re: documentation structure jian he <jian.universality@gmail.com>
Re: documentation structure Corey Huinker <corey.huinker@gmail.com>
Re: documentation structure Bruce Momjian <bruce@momjian.us>
Re: documentation structure Corey Huinker <corey.huinker@gmail.com>
Re: documentation structure Andres Freund <andres@anarazel.de>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Alvaro Herrera <alvherre@alvh.no-ip.org>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Tom Lane <tgl@sss.pgh.pa.us>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Tom Lane <tgl@sss.pgh.pa.us>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Alvaro Herrera <alvherre@alvh.no-ip.org>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure "David G. Johnston" <david.g.johnston@gmail.com>
Re: documentation structure Peter Eisentraut <peter@eisentraut.org>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Peter Eisentraut <peter@eisentraut.org>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure "David G. Johnston" <david.g.johnston@gmail.com>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Bruce Momjian <bruce@momjian.us>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure "David G. Johnston" <david.g.johnston@gmail.com>
Re: documentation structure Bruce Momjian <bruce@momjian.us>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Bruce Momjian <bruce@momjian.us>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Peter Eisentraut <peter@eisentraut.org>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Peter Eisentraut <peter@eisentraut.org>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Peter Eisentraut <peter@eisentraut.org>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure "David G. Johnston" <david.g.johnston@gmail.com>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure "David G. Johnston" <david.g.johnston@gmail.com>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Peter Eisentraut <peter@eisentraut.org>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure "David G. Johnston" <david.g.johnston@gmail.com>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure "David G. Johnston" <david.g.johnston@gmail.com>
Re: documentation structure Bruce Momjian <bruce@momjian.us>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure jian he <jian.universality@gmail.com>
Re: documentation structure jian he <jian.universality@gmail.com>
Re: documentation structure Corey Huinker <corey.huinker@gmail.com>
Re: documentation structure jian he <jian.universality@gmail.com>
Re: documentation structure Corey Huinker <corey.huinker@gmail.com>
Re: documentation structure Andrew Dunstan <andrew@dunslane.net>
Re: documentation structure Tatsuo Ishii <ishii@postgresql.org>
Re: documentation structure "David G. Johnston" <david.g.johnston@gmail.com>
Re: documentation structure Tom Lane <tgl@sss.pgh.pa.us>
Re: documentation structure Tatsuo Ishii <ishii@postgresql.org>
Re: documentation structure "David G. Johnston" <david.g.johnston@gmail.com>
Re: documentation structure Tom Lane <tgl@sss.pgh.pa.us>
Re: documentation structure Tatsuo Ishii <ishii@postgresql.org>
Re: documentation structure "David G. Johnston" <david.g.johnston@gmail.com>
Re: documentation structure jian he <jian.universality@gmail.com>
Re: documentation structure jian he <jian.universality@gmail.com>
Re: documentation structure Tom Lane <tgl@sss.pgh.pa.us>
Re: documentation structure Matthias van de Meent <boekewurm+postgres@gmail.com>
Re: documentation structure Robert Haas <robertmhaas@gmail.com>
Re: documentation structure Roberto Mello <roberto.mello@gmail.com>
I havent dealt with variadic yet, since the two styles are visually
different, not just markup (<optional>...</optional> renders as [...]).
The two styles for variadic are the what I call caller-style:
concat ( val1 "any" [, val2 "any" [, ...] ] )
format(formatstr text [, formatarg "any" [, ...] ])
While this style is obviously clumsier for us to compose, it does avoid relying on the user understanding what the word variadic means. Searching through online documentation of the python *args parameter, the word variadic never comes up, the closest they get is "variable length argument". I realize that python is not SQL, but I think it's a good point of reference for what concepts the average reader is likely to know.
Looking at the patch, I think it is good, though I'd consider doing some indentation for the nested <optional>s to allow the author to do more visual tag-matching. The ']'s were sufficiently visually distinct that we didn't really need or want nesting, but <optional> is just another tag to my eyes in a sea of tags.
В списке pgsql-hackers по дате отправления
От: Peter Eisentraut
Дата: