From: Maxim Cournoyer <maxim.cournoyer@gmail.com>
To: Arun Isaac <arunisaac@systemreboot.net>
Cc: 59217@debbugs.gnu.org, jgart <jgart@dismail.de>,
zimoun <zimon.toutoune@gmail.com>
Subject: [bug#59217] [PATCH] guix: lint: Improve message in linter warning.
Date: Tue, 21 Mar 2023 15:50:32 -0400 [thread overview]
Message-ID: <87edphnat3.fsf_-_@gmail.com> (raw)
In-Reply-To: <87bkoxbzoc.fsf@systemreboot.net> (Arun Isaac's message of "Wed, 23 Nov 2022 12:52:51 +0000")
Hi,
Arun Isaac <arunisaac@systemreboot.net> writes:
>> Well, maybe a paragraph in the manual under ’(guix) Synopses and
>> Descriptions’ is a better location for such explanations than the linter
>> message itself. WDYT?
>
> That sounds good. Detailed explanations do belong in the manual. But,
> the linter CLI output should link to the relevant section of the web
> manual. That would be better than sending people hunting in the
> manual. Many good linters for other programming languages do do this.
Instead of a bug in Emacs, I'd say it's rather a convention, rooted in
the fact that without the two-spaces trick, how would you reliably
locate the end of a sentence? A period followed by a capital letter
might happen in the middle of a sentence, which makes it ambiguous.
Note that two-spaces also exists as a typographical convention, called
"double sentence spacing". Here's some interesting quote from the
Wikipedia page [0]:
The text-editing environment in Emacs uses a double space following a
period to identify the end of sentences unambiguously; the
double-space convention prevents confusion with periods within
sentences that signify abbreviations. How Emacs recognizes the end of
a sentence is controlled by the settings sentence-end-double-space
and sentence-end.[71]
The Unix typesetter program Troff uses two spaces to mark the end of
a sentence.[72] This allows the typesetter to distinguish sentence
endings from abbreviations and to typeset them differently. Early
versions of Troff,[72] which only typeset in fixed-width fonts, would
automatically add a second space between sentences, which were
detected based on the combination of terminal punctuation and a line
feed.
Personally, I'd prefer not having explanations directly in the output of
Guix lint; it should be terse, as it's involved often and repeatedly.
[0] https://en.wikipedia.org/wiki/Sentence_spacing
--
Thanks,
Maxim
next prev parent reply other threads:[~2023-03-21 19:51 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-12 15:09 [bug#59217] [PATCH] guix: lint: Improve message in linter warning jgart via Guix-patches via
[not found] ` <handler.59217.B.166826577117982.ack@debbugs.gnu.org>
2022-11-12 15:15 ` [bug#59217] Acknowledgement ([PATCH] guix: lint: Improve message in linter warning.) jgart via Guix-patches via
2022-11-22 20:58 ` Arun Isaac
2022-11-23 10:13 ` zimoun
2022-11-23 12:52 ` Arun Isaac
2023-03-21 19:50 ` Maxim Cournoyer [this message]
2023-03-22 21:22 ` [bug#59217] [PATCH] guix: lint: Improve message in linter warning Arun Isaac
2023-03-23 2:52 ` Maxim Cournoyer
2023-03-22 21:37 ` jgart via Guix-patches via
2022-11-19 18:37 ` Ludovic Courtès
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87edphnat3.fsf_-_@gmail.com \
--to=maxim.cournoyer@gmail.com \
--cc=59217@debbugs.gnu.org \
--cc=arunisaac@systemreboot.net \
--cc=jgart@dismail.de \
--cc=zimon.toutoune@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.