Clarify errhint in sources.sgml

Started by Daniel Gustafssonalmost 3 years ago4 messagesdocs
Jump to latest
#1Daniel Gustafsson
daniel@yesql.se

It was noted in 20230712015948.byqaftt57glwknjz@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

Attachments:

errhint_example.diffapplication/octet-stream; name=errhint_example.diff; x-unix-mode=0644Download+1-1
#2Gurjeet Singh
gurjeet@singh.im
In reply to: Daniel Gustafsson (#1)
Re: Clarify errhint in sources.sgml

On Wed, Jul 12, 2023 at 12:08 AM Daniel Gustafsson <daniel@yesql.se> wrote:

It was noted in 20230712015948.byqaftt57glwknjz@awork3.anarazel.de that the

The URL of the link is below [1]/messages/by-id/20230712015948.byqaftt57glwknjz@awork3.anarazel.de.

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]: /messages/by-id/20230712015948.byqaftt57glwknjz@awork3.anarazel.de

Best regards,
Gurjeet
http://Gurje.et

#3Jonathan S. Katz
jkatz@postgresql.org
In reply to: Daniel Gustafsson (#1)
Re: Clarify errhint in sources.sgml

On 7/12/23 3:08 AM, Daniel Gustafsson wrote:

It was noted in 20230712015948.byqaftt57glwknjz@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

#4Daniel Gustafsson
daniel@yesql.se
In reply to: Jonathan S. Katz (#3)
Re: Clarify errhint in sources.sgml

On 12 Jul 2023, at 15:30, Jonathan S. Katz <jkatz@postgresql.org> wrote:

On 7/12/23 3:08 AM, Daniel Gustafsson wrote:

It was noted in 20230712015948.byqaftt57glwknjz@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