GNU bug report logs - #60902
[PATCH 06/25] gnu: Add go-github-com-jba-templatecheck.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 60902 in the body.
You can then email your comments to 60902 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Katherine Cox-Buday <cox.katherine.e <at> gmail.com>
To: guix-patches <at> gnu.org
Cc: Katherine Cox-Buday <cox.katherine.e <at> gmail.com>
Subject: [PATCH 06/25] gnu: Add go-github-com-jba-templatecheck.
Date: Tue, 17 Jan 2023 18:44:51 -0700

* gnu/packages/golang.scm (go-github-com-jba-templatecheck): New variable.
---
 gnu/packages/golang.scm | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/gnu/packages/golang.scm b/gnu/packages/golang.scm
index 9f7a8160de..aabaa6336c 100644
--- a/gnu/packages/golang.scm
+++ b/gnu/packages/golang.scm
@@ -8541,6 +8541,33 @@ (define-public go-github-com-jba-printsrc
     ;; MIT
     (license license:expat)))
 
+(define-public go-github-com-jba-templatecheck
+  (package
+    (name "go-github-com-jba-templatecheck")
+    (version "0.6.0")
+    (source (origin
+              (method git-fetch)
+              (uri (git-reference
+                    (url "https://github.com/jba/templatecheck")
+                    (commit (string-append "v" version))))
+              (file-name (git-file-name name version))
+              (sha256
+               (base32
+                "12iwkidz4p6wdl65jfddqxls80mv879k2rpb42dj7y4dja5advlc"))))
+    (build-system go-build-system)
+    (arguments
+     '(#:import-path "github.com/jba/templatecheck"))
+    (propagated-inputs (list go-github-com-google-safehtml))
+    (home-page "https://github.com/jba/templatecheck")
+    (synopsis "Checks Go templates for problems")
+    (description
+     "Package templatecheck checks Go templates for problems.  It can detect
+many errors that are normally caught only during execution.  Use templatecheck
+in tests to find template errors early, and along template execution paths
+that might only rarely be reached.")
+    ;; MIT
+    (license license:expat)))
+
 (define-public go-github-com-jbenet-go-context
   (let ((commit "d14ea06fba99483203c19d92cfcd13ebe73135f4")
         (revision "1"))
-- 
2.38.1

Message #24 received at 60902 <at> debbugs.gnu.org (full text, mbox):

From: "(" <paren <at> disroot.org>
To: "Katherine Cox-Buday" <cox.katherine.e <at> gmail.com>, <60902 <at> debbugs.gnu.org>
Subject: Re: [bug#60902] [PATCH 06/25] gnu: Add
 go-github-com-jba-templatecheck.
Date: Mon, 06 Feb 2023 22:07:44 +0000

[Message part 1 (text/plain, inline)]

* gnu/packages/golang.scm (go-github-com-jba-templatecheck): New variable.

> --- a/gnu/packages/golang.scm
> +++ b/gnu/packages/golang.scm

> @@ -8541,6 +8541,33 @@ (define-public go-github-com-jba-printsrc

> +    (synopsis "Checks Go templates for problems")

s/problems/errors/

> +    (description
> +     "Package templatecheck checks Go templates for problems.  It can detect
> +many errors that are normally caught only during execution.  Use templatecheck
> +in tests to find template errors early, and along template execution paths
> +that might only rarely be reached.")

  (description
   "This package provides a Go library for checking Go templates for errors,
  including many errors normally caught only during execution.")
  
> +    ;; MIT

Don't bother with the comment here :)

    -- (

[signature.asc (application/pgp-signature, inline)]

Message #27 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Katherine Cox-Buday <cox.katherine.e <at> gmail.com>
To: "( via Guix-patches" via <guix-patches <at> gnu.org>
Cc: "\(" <paren <at> disroot.org>, 60902 <at> debbugs.gnu.org
Subject: Re: [bug#60902] [PATCH 06/25] gnu: Add
 go-github-com-jba-templatecheck.
Date: Tue, 07 Feb 2023 10:12:31 -0700

"( via Guix-patches" via <guix-patches <at> gnu.org> writes:

> * gnu/packages/golang.scm (go-github-com-jba-templatecheck): New variable.
>
>> --- a/gnu/packages/golang.scm
>> +++ b/gnu/packages/golang.scm
>
>> @@ -8541,6 +8541,33 @@ (define-public go-github-com-jba-printsrc
>
>> +    (synopsis "Checks Go templates for problems")
>
> s/problems/errors/

Upstream's synopsis uses the word "validity". I think I probably pulled
the synopsis from the first sentence of upstream's description, which
uses the word "problems".

For future reference, would something like this really hold up a merge?

>> +    (description
>> +     "Package templatecheck checks Go templates for problems.  It can detect
>> +many errors that are normally caught only during execution.  Use templatecheck
>> +in tests to find template errors early, and along template execution paths
>> +that might only rarely be reached.")
>
>   (description
>    "This package provides a Go library for checking Go templates for errors,
>   including many errors normally caught only during execution.")

Can you give more general guidance on what a description should have? I
can't infer any general rules from the reviews you've given, other than
maybe you are suggesting shorter descriptions. But the manual says:

    Descriptions should take between five and ten lines.

So I think my inference is probably not correct.

>> +    ;; MIT
>
> Don't bother with the comment here :)

No? I like knowing what license things are! But if this is a style
thing, I can start leaving them off.

-- 
Katherine

Message #33 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "(" <paren <at> disroot.org>
To: "Katherine Cox-Buday" <cox.katherine.e <at> gmail.com>, "( via Guix-patches
 via" <guix-patches <at> gnu.org>
Cc: 60902 <at> debbugs.gnu.org
Subject: Re: [bug#60902] [PATCH 06/25] gnu: Add
 go-github-com-jba-templatecheck.
Date: Tue, 07 Feb 2023 17:41:19 +0000

[Message part 1 (text/plain, inline)]

On Tue Feb 7, 2023 at 5:12 PM GMT, Katherine Cox-Buday wrote:
> No? I like knowing what license things are! But if this is a style
> thing, I can start leaving them off.

MIT == Expat or X11; a comment noting that it's MIT is redundant :)

    -- (

[signature.asc (application/pgp-signature, inline)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.