Re: Probable documentation errors or improvements
Yaroslav <ladayaroslav@yandex.ru>
From: Щекин Ярослав <ladayaroslav@yandex.ru>
To: Justin Pryzby <pryzby@telsasoft.com>, Heikki Linnakangas <hlinnaka@iki.fi>
Cc: "pgsql-hackers@postgresql.org" <pgsql-hackers@postgresql.org>, David G Johnston <david.g.johnston@gmail.com>, Teodor Sigaev <teodor@sigaev.ru>, Oleg Bartunov <obartunov@postgrespro.ru>, Dmitry Ivanov <d.ivanov@postgrespro.ru>, Alexander Korotkov <a.korotkov@postgrespro.ru>, Arthur Zakirov <a.zakirov@postgrespro.ru>
Date: 2020-11-20T17:51:12Z
Lists: pgsql-hackers
Attachments
- (unnamed) (text/html)
- remaining_problems.txt (text/plain)
Thank you for preparing the patches, and Heikki Linnakangas for pushing those!
Yaroslav, could you prepare a patch for your remaining suggestions ?
I suggest to include just the handful of items which are most important (most
wrong/ambiguous/confusing).
Let me write this again: I'm not a native speaker, so not sure those are actually incorrect, and can't offer non-trivial suggestions.
Anyway, I've tried to remove the already fixed things (also by other patches mentioned in the thread) from my initial list, and attach it.
Also, I've looked over the pushed patches, and spotted these:
-- https://www.postgresql.org/docs/current/catalog-pg-authid.html
Table 51.8. pg_authid Columns
-- Some rows in the description have point at the end, some don't (seemingly at random).
The applied patch fixed only one of those cases... also seemingly at random. Would be nice if someone read the whole table and made a decision about how it should be. If (just guessing here) the rule is "there should be no point if it's just one sentence", then "Role bypasses every row level security policy, see Section 5.8 for more information." is still wrong.
Then, while ";" after "END" were added in doc/src/sgml/plpgsql.sgml, but in doc/src/sgml/func.sgml they still were not.
Finally, while the patches fix a lot of whitespace in function arguments, the original complaint about div() and mod() is still not fixed.
--
WBR, Yaroslav Schekin.
Commits
-
doc: Remove more notes about compatibilities with past versions
- 8a17f44c1e7a 14.0 landed
-
Misc documentation fixes.
- 660376397e0e 9.5.24 landed
- 67a6af69870d 9.6.20 landed
- 463bef28d8f2 10.15 landed
- 1e17fb935719 11.10 landed
- 7e175c53d997 12.5 landed
- 33acc6bc8795 13.1 landed
- c5f42daa6077 14.0 landed
-
Fix TRUNCATE doc: ALTER SEQUENCE RESTART is now transactional.
- d348473b783c 10.15 landed
- 1800686383f7 11.10 landed
- c092b2ee235e 12.5 landed
- 3b5bf7b893fc 13.1 landed
- 2a972e0165c9 14.0 landed
-
Fix output of tsquery example in docs.
- 07d46e7e077f 9.6.20 landed
- 609fe21c0dbd 10.15 landed
- cf01ade424cf 11.10 landed
- 660cbe807596 12.5 landed
- f0b3d3bb89ae 13.1 landed
- c0bc4c682ee2 14.0 landed
-
Fix doc for full text search distance operator.
- 8ae447e2f7cd 9.6.20 landed
- 71cb2e43cde6 10.15 landed
- aa560d3a6b37 11.10 landed
- f0e92bc4b0d7 12.5 landed
- f2f03f9bb10b 13.1 landed
- 1a64c7636f24 14.0 landed
-
Phrase full text search.
- bb140506df60 9.6.0 cited