Re: documentation update for doc/src/sgml/func.sgml - Mailing list pgsql-hackers

From Fabien COELHO
Subject Re: documentation update for doc/src/sgml/func.sgml
Date
Msg-id alpine.DEB.2.10.1408211139450.21654@sto
Whole thread Raw
In response to documentation update for doc/src/sgml/func.sgml  (Andreas 'ads' Scherbaum <adsmail@wars-nicht.de>)
Responses Re: documentation update for doc/src/sgml/func.sgml
List pgsql-hackers
> attached is a small patch which updates doc/src/sgml/func.sgml. The change 
> explains that functions like round() and others might behave different 
> depending on your operating system (because of rint(3)) and that this is 
> according to an IEEE standard. It also points out that #.5 is not always 
> rounded up, as expected from a mathematical point of view.

Applied on head & read. I'm not a native English speaker, but the English 
looked right to me.

Comments:

I'm not sure that the "note that" on the third line is useful.

I do not understand why the last sentence in the first paragraph about 
bitwise ops is put there with rounding issues, which seem unrelated. It 
seems to me that it belongs to the second paragraph which is about bitwise 
operators.

The wikipedia link can be simplified to a much cleaner:
    http://en.wikipedia.org/wiki/IEEE_floating_point#Rounding_rules

Also, I submitted docs with relevant wikipedia links which was stripped of 
these before committing. I'm wondering whether there is a general policy 
not to put external links from within the text in the documentation. There 
are very few of them, most in "acronym.sgml".

I would suggest to put relevant tags around functions and types, like: 
"<function>round()</>" and "<type>NUMERIC</>".

-- 
Fabien.



pgsql-hackers by date:

Previous
From: Fabien COELHO
Date:
Subject: Re: run xmllint during build (was Re: need xmllint on borka)
Next
From: Amit Kapila
Date:
Subject: Re: option -T in pg_basebackup doesn't work on windows