pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedClarify errhint in sources.sgml
4+ messages / 3 participants
[nested] [flat]
* Clarify errhint in sources.sgml
@ 2023-07-12 07:08 Daniel Gustafsson <daniel@yesql.se>
0 siblings, 2 replies; 4+ messages in thread
From: Daniel Gustafsson @ 2023-07-12 07:08 UTC (permalink / raw)
To: Pg Docs <pgsql-docs@lists.postgresql.org>
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:
[application/octet-stream] errhint_example.diff (497B, ../../F02F4B4F-7B7E-406A-B25A-FF2AA300AB9A@yesql.se/2-errhint_example.diff)
download | inline diff:
diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml
index 0db36aee2f..514090d5a6 100644
--- a/doc/src/sgml/sources.sgml
+++ b/doc/src/sgml/sources.sgml
@@ -470,7 +470,7 @@ IpcMemoryCreate: shmget(key=%d, size=%u, 0%o) failed: %m
<programlisting>
Primary: could not create shared memory segment: %m
Detail: Failed syscall was shmget(key=%d, size=%u, 0%o).
-Hint: the addendum
+Hint: The addendum, written as a complete sentence.
</programlisting>
</para>
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: Clarify errhint in sources.sgml
@ 2023-07-12 07:55 Gurjeet Singh <gurjeet@singh.im>
parent: Daniel Gustafsson <daniel@yesql.se>
1 sibling, 0 replies; 4+ messages in thread
From: Gurjeet Singh @ 2023-07-12 07:55 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; +Cc: Pg Docs <pgsql-docs@lists.postgresql.org>
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].
> 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.byqaftt57glwknjz@awork3.anarazel.de
Best regards,
Gurjeet
http://Gurje.et
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: Clarify errhint in sources.sgml
@ 2023-07-12 13:30 Jonathan S. Katz <jkatz@postgresql.org>
parent: Daniel Gustafsson <daniel@yesql.se>
1 sibling, 1 reply; 4+ messages in thread
From: Jonathan S. Katz @ 2023-07-12 13:30 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; Pg Docs <pgsql-docs@lists.postgresql.org>
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
Attachments:
[application/pgp-signature] OpenPGP_signature (839B, ../../150f6aa7-1f42-ba3d-7da9-3265f1013c9a@postgresql.org/2-OpenPGP_signature)
download
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: Clarify errhint in sources.sgml
@ 2023-07-12 14:01 Daniel Gustafsson <daniel@yesql.se>
parent: Jonathan S. Katz <jkatz@postgresql.org>
0 siblings, 0 replies; 4+ messages in thread
From: Daniel Gustafsson @ 2023-07-12 14:01 UTC (permalink / raw)
To: Jonathan S. Katz <jkatz@postgresql.org>; +Cc: Pg Docs <pgsql-docs@lists.postgresql.org>
> 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
^ permalink raw reply [nested|flat] 4+ messages in thread
end of thread, other threads:[~2023-07-12 14:01 UTC | newest]
Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2023-07-12 07:08 Clarify errhint in sources.sgml Daniel Gustafsson <daniel@yesql.se>
2023-07-12 07:55 ` Gurjeet Singh <gurjeet@singh.im>
2023-07-12 13:30 ` Jonathan S. Katz <jkatz@postgresql.org>
2023-07-12 14:01 ` Daniel Gustafsson <daniel@yesql.se>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox