[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#44675: guix lint: support for spellchecker or basic grammar
From: |
Vagrant Cascadian |
Subject: |
bug#44675: guix lint: support for spellchecker or basic grammar |
Date: |
Thu, 22 Apr 2021 10:57:56 -0700 |
On 2021-04-22, Maxime Devos wrote:
> + (define (check-pluralized-this-package description)
> + "Check that DESCRIPTION does not contain This packages"
>
> The sentence structure would be clearer if you used quotes here,
> something like "Check that DESCRIPTION does not contain ‘This packages’".
Any compelling reason to use ‘This packages’ vs. 'This packages' ? It
seems other quotes in guix/lint.scm use '' also, and I'm not apparently
skilled enough with a keyboard to generate ‘’-style quotes... :)
> + (if (string-match "This packages" description)
> + (list
> + (make-warning package
> + (G_ "description contains This Packages but should just
> be This package")))
>
> There are no package descriptions containing "This Packages".
> Did you mean "This packages"?
Nice catch, thanks!
>> +(test-equal "description: pluralized this package"
> Quotes: "description: pluralized ‘this package’".
Noted.
>> + "description contains This Packages but should just be This package"
> Capitalisation error: This Packages --> This packages
> Also, quotes: "description contains ‘This packages’ but should just be ‘This
> package’".
Again, nice catch!
Updated the commit message and incorporated the above suggestions into
the updated attached patch.
live well,
vagrant
From 4e724fbe9815e1c27967b835f08d2259164538ba Mon Sep 17 00:00:00 2001
From: Vagrant Cascadian <vagrant@debian.org>
Date: Wed, 21 Apr 2021 09:26:45 -0700
Subject: [PATCH] lint: Add description check for pluralized "This package"
Partial fix for: https://issues.guix.gnu.org/44675
* guix/lint.scm (check-pluralized-this-package): Add check for
occurances of "This packages" in package descriptions.
* tests/lint.scm: Add test.
---
guix/lint.scm | 9 +++++++++
tests/lint.scm | 7 +++++++
2 files changed, 16 insertions(+)
diff --git a/guix/lint.scm b/guix/lint.scm
index 1bebfe03d3..e00048349b 100644
--- a/guix/lint.scm
+++ b/guix/lint.scm
@@ -221,6 +221,14 @@ markup is valid return a plain-text version of
DESCRIPTION, otherwise #f."
(G_ "Texinfo markup in description is invalid")
#:field 'description))))
+ (define (check-pluralized-this-package description)
+ "Check that DESCRIPTION does not contain 'This packages'"
+ (if (string-match "This packages" description)
+ (list
+ (make-warning package
+ (G_ "description contains 'This packages' but should
just be 'This package'")))
+ '()))
+
(define (check-trademarks description)
"Check that DESCRIPTION does not contain '™' or '®' characters. See
http://www.gnu.org/prep/standards/html_node/Trademarks.html."
@@ -283,6 +291,7 @@ by two spaces; possible infraction~p at ~{~a~^, ~}")
(check-not-empty description)
(check-quotes description)
(check-trademarks description)
+ (check-pluralized-this-package description)
;; Use raw description for this because Texinfo rendering
;; automatically fixes end of sentence space.
(check-end-of-sentence-space description)
diff --git a/tests/lint.scm b/tests/lint.scm
index a2c8665142..3e1b95680a 100644
--- a/tests/lint.scm
+++ b/tests/lint.scm
@@ -160,6 +160,13 @@
(description "This is a 'quoted' thing."))))
(check-description-style pkg))))
+(test-equal "description: pluralized 'This package'"
+ "description contains 'This packages' but should just be 'This package'"
+ (single-lint-warning-message
+ (let ((pkg (dummy-package "x"
+ (description "This packages is a typo."))))
+ (check-description-style pkg))))
+
(test-equal "synopsis: not a string"
"invalid synopsis: #f"
(single-lint-warning-message
--
2.30.2
signature.asc
Description: PGP signature