Re: Consistent reference to RFCs in the documentation

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: Heikki Linnakangas <hlinnaka(at)iki(dot)fi>
Cc: Pg Docs <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: Consistent reference to RFCs in the documentation
Date: 2020-12-01 12:55:27
Message-ID: 2C7F4A07-49AA-4FAD-A152-EB9DAD07D211@yesql.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

> On 1 Dec 2020, at 13:39, Heikki Linnakangas <hlinnaka(at)iki(dot)fi> wrote:
> On 05/11/2020 17:09, Daniel Gustafsson wrote:

>> The attached patch adds ulinks for all
>> RFC's and marks subsequent mentions as acronym to make the docs consistent. It
>> also spells all as "RFC <number>" with a whitespace as that was the most
>> commonly used spelling (there is no RFC for how to reference to an RFC so we're
>> free to choose).
>
> There is RFC 7322, "RFC Style Guide", Section 3.5 Citations (https://tools.ietf.org/html/rfc7322#section-3.5). That's for the style used in RFCs themselves. It recommends "RFC <number>" as well.

Interesting, I've looked for that more than once but failed to find that
section. Thanks for pointing it out.

> Pushed, thanks!

Thanks!

cheers ./daenil

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Bruce Momjian 2020-12-02 19:21:42 Re: Consistent reference to RFCs in the documentation
Previous Message Heikki Linnakangas 2020-12-01 12:39:04 Re: Consistent reference to RFCs in the documentation