Re: doc: add missing "id" attributes to extension packaging page

Поиск
Список
Период
Сортировка
От Corey Huinker
Тема Re: doc: add missing "id" attributes to extension packaging page
Дата
Msg-id CADkLM=d16C_aG2UZLTnZ+_D_od1ysh2Atm-=-uOiY8wfRyZyUA@mail.gmail.com
обсуждение исходный текст
Ответ на Re: doc: add missing "id" attributes to extension packaging page  (Brar Piening <brar@gmx.de>)
Ответы Re: doc: add missing "id" attributes to extension packaging page  ("Karl O. Pinc" <kop@karlpinc.com>)
Список pgsql-hackers
TBH I'm a bit afraid that people will immediately start complaining
about the failing docs builds after this got applied since it forces
them to add ids to all varlistenries in a variablelist if they add one,
which can be perceived as quite a burden (also committers and reviewers
will have to get used to always watch out for failing docs builds
because of this).

As a person who had to re-rebase a patch because I discovered that id tags had been added to one of the files I was working on, I can confidently say "don't worry". It wasn't that big of a deal, I wasn't even following this thread at the time and I immediately figured out what had happened and what was expected of me. So it isn't that much of an inconvenience. If there is a negative consequence to this change, it would be that it might incentivize patch writers to omit documentation completely at the early stages. But I don't think that's a problem because people generally see a lack of documentation as a clue that maybe the patch isn't ready to be reviewed, and this change would only reinforce that litmus test.

I had suggested we do something like this a few years back (the ids, that is. the idea that we could check for compliance was beyond my imagination at the time), and I'm glad to see both finally happening.

While I can foresee people overlooking the docs build, such oversights won't go long before being caught, and the fix is simple.  Now if we can just get a threaded version of xlstproc to make the builds faster...

p.s. I'm "Team Paperclip" when it comes to the link hint, but let's get the feature in first and worry about the right character later.

В списке pgsql-hackers по дате отправления:

Предыдущее
От: Robert Haas
Дата:
Сообщение: Re: Non-superuser subscription owners
Следующее
От: Greg Stark
Дата:
Сообщение: Re: Code checks for App Devs, using new options for transaction behavior