Clarify errhint in sources.sgml
It was noted in 20230712015948.byqaftt57glwk...@awork3.anarazel.de that the errhint example in sources.sgml isn't as helpful as it could be. errhint should use a complete sentence, but the example doesn't, so I propose the attached change which makes it so. The style for hints is clearly spelled out further down on the page, but for anyone looking for a quick answer and not reading the whole page the current example might be misleading. -- Daniel Gustafsson errhint_example.diff Description: Binary data
Re: Clarify errhint in sources.sgml
On Wed, Jul 12, 2023 at 12:08 AM Daniel Gustafsson wrote: > > It was noted in 20230712015948.byqaftt57glwk...@awork3.anarazel.de that the The URL of the link is below [1]. > errhint example in sources.sgml isn't as helpful as it could be. errhint > should use a complete sentence, but the example doesn't, so I propose the > attached change which makes it so. The style for hints is clearly spelled out > further down on the page, but for anyone looking for a quick answer and not > reading the whole page the current example might be misleading. Following from that discussion, the patch looks good to me. [1]: https://www.postgresql.org/message-id/20230712015948.byqaftt57glwk...@awork3.anarazel.de Best regards, Gurjeet http://Gurje.et
Re: Clarify errhint in sources.sgml
On 7/12/23 3:08 AM, Daniel Gustafsson wrote: It was noted in 20230712015948.byqaftt57glwk...@awork3.anarazel.de that the errhint example in sources.sgml isn't as helpful as it could be. errhint should use a complete sentence, but the example doesn't, so I propose the attached change which makes it so. The style for hints is clearly spelled out further down on the page, but for anyone looking for a quick answer and not reading the whole page the current example might be misleading. +1. No need to bikeshed this one. Jonathan OpenPGP_signature Description: OpenPGP digital signature
Re: Clarify errhint in sources.sgml
> On 12 Jul 2023, at 15:30, Jonathan S. Katz wrote: > > On 7/12/23 3:08 AM, Daniel Gustafsson wrote: >> It was noted in 20230712015948.byqaftt57glwk...@awork3.anarazel.de that the >> errhint example in sources.sgml isn't as helpful as it could be. errhint >> should use a complete sentence, but the example doesn't, so I propose the >> attached change which makes it so. The style for hints is clearly spelled >> out >> further down on the page, but for anyone looking for a quick answer and not >> reading the whole page the current example might be misleading. > > +1. No need to bikeshed this one. Thanks for review, I'll go make that happen then in a bit unless anyone else objects. -- Daniel Gustafsson
