Re: Patch to document base64 encoding

Fabien COELHO <coelho@cri.ensmp.fr>

From: Fabien COELHO <coelho@cri.ensmp.fr>
To: "Karl O. Pinc" <kop@meme.com>
Cc: PostgreSQL Developers <pgsql-hackers@lists.postgresql.org>
Date: 2019-03-06T18:30:16Z
Lists: pgsql-hackers
> Attached: doc_base64_v7.patch

Patch applies cleanly, doc compiles, navigation tested and ok.

"... section 6.8" -> "... Section 6.8" (capital S).

"The string and the binary encode and decode functions..." sentence looks 
strange to me, especially with the English article that I do not really 
master, so maybe it is ok. I'd have written something more 
straightforward, eg: "Functions encode and decode support the following 
encodings:", and also I'd use a direct "Function <...>decode</...> ..." 
rather than "The <function>decode</function> function ..." (twice).

Maybe I'd use the exact same grammatical structure for all 3 cases, 
starting with "The <>whatever</> encoding converts bla bla bla" instead of 
varying the sentences.

Otherwise, all explanations look both precise and useful to me.

-- 
Fabien.


Commits

  1. Doc: rearrange the documentation of binary-string functions.