Re: documentation update for doc/src/sgml/func.sgml

From: Michael Paquier <michael(dot)paquier(at)gmail(dot)com>
To: "Andreas 'ads' Scherbaum" <adsmail(at)wars-nicht(dot)de>
Cc: PostgreSQL mailing lists <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: documentation update for doc/src/sgml/func.sgml
Date: 2014-12-22 05:30:40
Message-ID: CAB7nPqSJuo-umKBftNO04nwGdomWwTPM0YDPJOrj9KdQKgASMw@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Sat, Oct 18, 2014 at 4:12 AM, Andreas 'ads' Scherbaum
<adsmail(at)wars-nicht(dot)de> wrote:
> On 09/14/2014 06:32 PM, Peter Eisentraut wrote:
>>
>> On 9/12/14 3:13 PM, Andreas 'ads' Scherbaum wrote:
>>>
>>> Of course a general rule how to link to WP would be nice ...
>>
>>
>> I think Wikipedia links should be avoided altogether. We can assume
>> that readers are technically proficient to look up general technical
>> concepts on their own using a reference system of their choice.
>>
>> In cases where a link is warranted, it is better to construct a proper
>> bibliographic citation to the primary source material, such as an IEEE
>> standard or an academic paper, in a way that will stand the test of time.
>
>
> That's a clear statement, and makes sense. Should be written down somewhere,
> so it can be found again.
>
>
>> Independent of that, it is actually not correct that "we use the IEEE's
>> rules", because "we" don't use any rules, that is up to the operating
>> system/platform. While most platforms indeed do use the IEEE
>> floating-point standard more less, some don't. Section 8.1.3 tries to
>> point that out.
>
>
> New version attached, WP link removed, wording changed.
Documentation format is still incorrect. The function names should be
put in a block <function>, same for the value 0.5 with <literal> and
the data types NUMERIC and REAL. Corrected patch is attached. The rest
looks fine to me, I am switching it to Ready for committer.
--
Michael

Attachment Content-Type Size
20141222_funcs_docfix.patch text/x-patch 1.3 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Tatsuo Ishii 2014-12-22 06:36:36 Re: pgbench -f and vacuum
Previous Message Michael Paquier 2014-12-22 05:05:41 Re: install libpq.dll in bin directory on Windows / Cygwin