Re: [PATCH] Missing links between system catalog documentationpages
От | Fabien COELHO |
---|---|
Тема | Re: [PATCH] Missing links between system catalog documentationpages |
Дата | |
Msg-id | alpine.DEB.2.22.394.2006210850220.859381@pseudo обсуждение исходный текст |
Ответ на | Re: [PATCH] Missing links between system catalog documentation pages (ilmari@ilmari.org (Dagfinn Ilmari Mannsåker)) |
Ответы |
Re: [PATCH] Missing links between system catalog documentation pages
Re: [PATCH] Missing links between system catalog documentation pages |
Список | pgsql-hackers |
Hello Dagfinn, >>>> The attached patch applies cleanly, doc generation is ok. I'm ok with adding such links systematically. >>>> makes the first mention of another system catalog or view (as well as >>>> pg_hba.conf in pg_hba_file_lines) a link, for easier navigation. >> >> Why only the first mention? It seems unlikely that I would ever read >> such chapter linearly, and even so that I would want to jump especially >> on the first occurrence but not on others, so ISTM that it should be >> done all mentions? > > It's the first mention in the introductory paragraph of _each_ catalog > table/view page, not the first mention in the entire catalogs.sgml file. > E.g. https://www.postgresql.org/docs/current/catalog-pg-aggregate.html > has two mentions of pg_proc one word apart: > > Each entry in pg_aggregate is an extension of an entry in pg_proc. The > pg_proc entry carries the aggregate's name, … > > I didn't think there was much point in linkifying both in that case, and > other similar situations. The point is that the user reads a sentence, attempts to jump but sometimes can't, because the is not the first occurrence. I'd go for all mentions of another relation should be link. Alse, ISTM you missed some, maybe you could consider adding them? eg pg_database in the very first paragraph of the file, pg_attrdef in pg_attribute description, quite a few in pg_class… -- Fabien.
В списке pgsql-hackers по дате отправления: