unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
* [bug#59217] [PATCH] guix: lint: Improve message in linter warning.
@ 2022-11-12 15:09 jgart via Guix-patches via
       [not found] ` <handler.59217.B.166826577117982.ack@debbugs.gnu.org>
  2022-11-19 18:37 ` [bug#59217] [PATCH] guix: lint: Improve message in linter warning Ludovic Courtès
  0 siblings, 2 replies; 6+ messages in thread
From: jgart via Guix-patches via @ 2022-11-12 15:09 UTC (permalink / raw)
  To: 59217; +Cc: jgart

* guix/lint.scm (check-end-of-sentence-space): Improve message.
---
 guix/lint.scm | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/guix/lint.scm b/guix/lint.scm
index 8e3976171f..37a9539e2c 100644
--- a/guix/lint.scm
+++ b/guix/lint.scm
@@ -14,6 +14,7 @@
 ;;; Copyright © 2021 Xinglu Chen <public@yoctocell.xyz>
 ;;; Copyright © 2021, 2022 Maxime Devos <maximedevos@telenet.be>
 ;;; Copyright © 2021 Brice Waegeneire <brice@waegenei.re>
+;;; Copyright © 2022 jgart <jgart@dismail.de>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -409,7 +410,7 @@ (define (check-end-of-sentence-space description)
           (list
            (make-warning package
                          (G_ "sentences in description should be followed ~
-by two spaces; possible infraction~p at ~{~a~^, ~}")
+by two spaces due to issues wth Emacs; possible infraction~p at ~{~a~^, ~}")
                          (list (length infractions)
                                infractions)
                          #:field 'description)))))
-- 
2.38.1





^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [bug#59217] Acknowledgement ([PATCH] guix: lint: Improve message in linter warning.)
       [not found] ` <handler.59217.B.166826577117982.ack@debbugs.gnu.org>
@ 2022-11-12 15:15   ` jgart via Guix-patches via
  2022-11-22 20:58     ` Arun Isaac
  0 siblings, 1 reply; 6+ messages in thread
From: jgart via Guix-patches via @ 2022-11-12 15:15 UTC (permalink / raw)
  To: 59217; +Cc: Arun Isaac

On Sat, 12 Nov 2022 15:10:02 +0000 help-debbugs@gnu.org (GNU bug Tracking System) wrote:
> Thank you for filing a new bug report with debbugs.gnu.org.

Hi Arun,

Not sure if you remember that conversation we had about the linter
warning regarding emacs and having to use two spaces in description
field sentences.

Would you mind recapping the issue so that I can improve this message further.

What I wrote is currently vague:

Why do the sentences in the description field have to be separated by two spaces due to Emacs?

all best,

jgart




^ permalink raw reply	[flat|nested] 6+ messages in thread

* [bug#59217] [PATCH] guix: lint: Improve message in linter warning.
  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-19 18:37 ` Ludovic Courtès
  1 sibling, 0 replies; 6+ messages in thread
From: Ludovic Courtès @ 2022-11-19 18:37 UTC (permalink / raw)
  To: jgart; +Cc: 59217

Hi,

jgart <jgart@dismail.de> skribis:

> * guix/lint.scm (check-end-of-sentence-space): Improve message.

[...]

> -by two spaces; possible infraction~p at ~{~a~^, ~}")
> +by two spaces due to issues wth Emacs; possible infraction~p at ~{~a~^, ~}")

Probably the two-space story needs an explanation, but what about adding
it to the manual, with a cross-ref to the relevant Emacs manual section?

Thanks,
Ludo’.




^ permalink raw reply	[flat|nested] 6+ messages in thread

* [bug#59217] Acknowledgement ([PATCH] guix: lint: Improve message in linter warning.)
  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
  0 siblings, 1 reply; 6+ messages in thread
From: Arun Isaac @ 2022-11-22 20:58 UTC (permalink / raw)
  To: jgart, 59217


Hi jgart,

> Not sure if you remember that conversation we had about the linter
> warning regarding emacs and having to use two spaces in description
> field sentences.

Yes, I remember the conversation.

> Would you mind recapping the issue so that I can improve this message
> further.

My original point was that the linter should not simply complain about
the absence of double spaces but also explain why double spaces are
required. Double spaces are required because Emacs sentence commands
such as M-a and M-e only work when sentences are separated by double
spaces. To be honest, I would consider this an Emacs bug. But, it's
probably impossible to achieve consensus on such a bold claim. ;-)

So, at the very least, the Guix linter should explain why double spaces
are required. As a general rule for all linter messages, contributors
will be happier when the linter explains the rationale for various
messages. Most people don't like doing things without understanding why
they have to do them.

Regards,
Arun




^ permalink raw reply	[flat|nested] 6+ messages in thread

* [bug#59217] Acknowledgement ([PATCH] guix: lint: Improve message in linter warning.)
  2022-11-22 20:58     ` Arun Isaac
@ 2022-11-23 10:13       ` zimoun
  2022-11-23 12:52         ` Arun Isaac
  0 siblings, 1 reply; 6+ messages in thread
From: zimoun @ 2022-11-23 10:13 UTC (permalink / raw)
  To: Arun Isaac, jgart, 59217

Hi Arun,

On Tue, 22 Nov 2022 at 20:58, Arun Isaac <arunisaac@systemreboot.net> wrote:

> My original point was that the linter should not simply complain about
> the absence of double spaces but also explain why double spaces are
> required. Double spaces are required because Emacs sentence commands
> such as M-a and M-e only work when sentences are separated by double
> spaces. To be honest, I would consider this an Emacs bug. But, it's
> probably impossible to achieve consensus on such a bold claim. ;-)

Indeed, it is impossible to achieve consensus since it is probably not
an Emacs bug but an historical inheritance of typographical convention,
see [1,2].

1: <https://en.wikipedia.org/wiki/Sentence_spacing>
2: <https://en.wikipedia.org/wiki/History_of_sentence_spacing>


> So, at the very least, the Guix linter should explain why double spaces
> are required. As a general rule for all linter messages, contributors
> will be happier when the linter explains the rationale for various
> messages. Most people don't like doing things without understanding why
> they have to do them.

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?


Cheers,
simon




^ permalink raw reply	[flat|nested] 6+ messages in thread

* [bug#59217] Acknowledgement ([PATCH] guix: lint: Improve message in linter warning.)
  2022-11-23 10:13       ` zimoun
@ 2022-11-23 12:52         ` Arun Isaac
  0 siblings, 0 replies; 6+ messages in thread
From: Arun Isaac @ 2022-11-23 12:52 UTC (permalink / raw)
  To: zimoun, jgart, 59217


> 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.

Cheers!




^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2022-11-23 12:54 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
2022-11-19 18:37 ` [bug#59217] [PATCH] guix: lint: Improve message in linter warning Ludovic Courtès

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).