Re: Should we put command options in alphabetical order in the doc? - Mailing list pgsql-hackers

From Daniel Gustafsson
Subject Re: Should we put command options in alphabetical order in the doc?
Date
Msg-id 6D2F8F5C-50AA-4062-9D6A-20C6332E0AEA@yesql.se
Whole thread Raw
In response to Re: Should we put command options in alphabetical order in the doc?  (Peter Eisentraut <peter.eisentraut@enterprisedb.com>)
List pgsql-hackers
> On 19 Apr 2023, at 10:52, Peter Eisentraut <peter.eisentraut@enterprisedb.com> wrote:

> For reference material, easy lookup should be a priority.

+1. Alphabetical ordering is consistent with POLA.

> For a narrative chapter on VACUUM, you can introduce the options in any other
> suitable order.


I would even phrase it such that in this case one *should* present the options
in the order most suitable to educate the reader.

--
Daniel Gustafsson




pgsql-hackers by date:

Previous
From: Peter Eisentraut
Date:
Subject: Re: Should we put command options in alphabetical order in the doc?
Next
From: "Hayato Kuroda (Fujitsu)"
Date:
Subject: RE: Time delayed LR (WAS Re: logical replication restrictions)