all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Katherine Cox-Buday <cox.katherine.e@gmail.com>
To: 60910@debbugs.gnu.org
Cc: paren@disroot.org
Subject: [bug#60910] [PATCH 12/25] gnu: Add xurls.
Date: Tue, 07 Feb 2023 10:51:14 -0700	[thread overview]
Message-ID: <87357hxt2l.fsf@gmail.com> (raw)
In-Reply-To: <CQBU5BSR09DA.YX8I33ULW77G@guix-framework> (guix-patches@gnu.org's message of "Mon, 06 Feb 2023 22:32:55 +0000")

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

> * gnu/packages/golang.scm (xurls): New variable.
>
>> --- a/gnu/packages/golang.scm
>> +++ b/gnu/packages/golang.scm
>
>> @@ -9760,6 +9760,38 @@ (define-public go-go-uber-org-multierr
>
>> +    (arguments
>> +     `(#:import-path "mvdan.cc/xurls/v2"
>> +       #:unpack-path "mvdan.cc/xurls/v2"
>> +       #:phases (modify-phases %standard-phases
>> +                  (replace 'build
>> +                    (lambda arguments
>> +                      (apply (assoc-ref %standard-phases
>> +                                        'build)
>> +                             `(,@arguments #:import-path
>> +                               "mvdan.cc/xurls/v2/cmd/xurls")))))))
>
> I'm not certain what you're trying to accomplish here, but would you be able
> to replace this with:
>
>   (arguments
>    `(#:import-path "mvdan.cc/xurls/v2"
>      #:unpack-path "mvdan.cc/xurls/v2/cmd/xurls"))
>
> ?

Hm, I'm sure I would have tried that, but I'll check and see if I can
condense this per your suggestion. Thanks!

>> +    (inputs (list go-golang-org-x-sync go-github-com-rogpeppe-go-internal))
>
> Add newlines after the ``inputs'' symbol and between the inputs :)

Why wouldn't `guix style` and `guix lint` correct this? I want to meet
the style guidelines, and I don't mean this as a contrarian statement,
but I'll never get this right unless a tool tells me it's wrong (or
ideally fixes it for me).

>> +    (description
>> +     "Xurls extracts urls from plain text using regular expressions.  It can
>> +be used as both a binary and a library.")
>
> s/Xurls extracts/This package provides a Go library for extracting/

https://guix.gnu.org/en/manual/devel/en/guix.html#Synopses-and-Descriptions:

    [Synopses] must not start with “a” or “the”, which usually does not
    bring anything; for instance, prefer “File-frobbing tool” over “A
    tool that frobs files”. The synopsis should say what the package
    is—e.g., “Core GNU utilities (file, text, shell)”—or what it is used
    for—e.g., the synopsis for GNU grep is “Print lines matching a
    pattern”.

The manual is speaking of synopses, but does it apply to descriptions
too? It seems to me like beginning the description with the name of the
binary is more correct than a self-referential "This package", which I
think meets the manual's qualifier for "does not bring anything".

Also, `Xurls` is both a library and an executable. This package is for
the executable, and a separate one was provided for the library. I think
it's probably better to keep it in the style of "$BINARY (thing that it
does)".

WDYT? These are just my opinions, and I'm open to learning! Please
include the "why" so I can have better judgment in the future.

-- 
Katherine




  reply	other threads:[~2023-02-07 17:52 UTC|newest]

Thread overview: 77+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-18  1:44 [bug#60899] [PATCH 00/25] gnu: golang: Add gopls Katherine Cox-Buday
2023-01-18  1:44 ` [bug#60903] [PATCH 01/25] gnu: go-golang-org-x-sync: Update to 0.1.0-1.8fcdb60 Katherine Cox-Buday
2023-02-06 18:22   ` ( via Guix-patches via
2023-01-18  1:44 ` [bug#60898] [PATCH 02/25] gnu: go-golang-org-x-mod: Update to 0.7.0 Katherine Cox-Buday
2023-02-06 18:24   ` ( via Guix-patches via
2023-01-18  1:44 ` [bug#60901] [PATCH 03/25] gnu: Add go-golang-org-x-exp Katherine Cox-Buday
2023-02-06 19:13   ` ( via Guix-patches via
2023-02-07 16:28     ` Katherine Cox-Buday
2023-02-07 17:39       ` ( via Guix-patches via
2023-01-18  1:44 ` [bug#60900] [PATCH 04/25] gnu: Add go-github-com-jba-printsrc Katherine Cox-Buday
2023-02-06 19:15   ` ( via Guix-patches via
2023-01-18  1:44 ` [bug#60904] [PATCH 05/25] gnu: Add go-github-com-google-safehtml Katherine Cox-Buday
2023-02-06 22:04   ` ( via Guix-patches via
2023-02-07 16:41     ` Katherine Cox-Buday
2023-02-07 17:45       ` ( via Guix-patches via
2023-01-18  1:44 ` [bug#60902] [PATCH 06/25] gnu: Add go-github-com-jba-templatecheck Katherine Cox-Buday
2023-02-06 22:07   ` ( via Guix-patches via
2023-02-07 17:12     ` Katherine Cox-Buday
2023-02-07 17:41       ` ( via Guix-patches via
2023-01-18  1:44 ` [bug#60907] [PATCH 07/25] gnu: go-github-com-google-go-cmp-cmp: Update to 0.5.9 Katherine Cox-Buday
2023-02-06 22:20   ` ( via Guix-patches via
2023-02-07 17:28     ` Katherine Cox-Buday
2023-01-18  1:44 ` [bug#60905] [PATCH 08/25] gnu: go-github-com-pkg-diff: Update to 0.0.0-20210226163009-20ebb0f2a09e Katherine Cox-Buday
2023-02-06 22:04   ` Christopher Baines
2023-02-06 22:20   ` ( via Guix-patches via
2023-02-07 17:04     ` Katherine Cox-Buday
2023-02-07 17:48       ` ( via Guix-patches via
2023-02-08 11:47       ` Christopher Baines
2023-01-18  1:44 ` [bug#60906] [PATCH 09/25] gnu: go-github-com-rogpeppe-go-internal: Update to 1.9.0 Katherine Cox-Buday
2023-02-06 22:21   ` ( via Guix-patches via
2023-01-18  1:44 ` [bug#60908] [PATCH 10/25] gnu: gopkg-in-errgo-fmt-errors: Rename package to go-gopkg-in-errgo-fmt-errors Katherine Cox-Buday
2023-02-06 22:17   ` Christopher Baines
2023-02-07 17:20     ` Katherine Cox-Buday
2023-02-08 11:45       ` Christopher Baines
2023-02-06 22:22   ` ( via Guix-patches via
2023-01-18  1:44 ` [bug#60909] [PATCH 11/25] gnu: go-golang-org-x-tools: Update to 0.5.0 Katherine Cox-Buday
2023-02-06 22:23   ` ( via Guix-patches via
2023-01-18  1:44 ` [bug#60910] [PATCH 12/25] gnu: Add xurls Katherine Cox-Buday
2023-02-06 22:32   ` ( via Guix-patches via
2023-02-07 17:51     ` Katherine Cox-Buday [this message]
2023-01-18  1:44 ` [bug#60911] [PATCH 13/25] gnu: Add go-mvdan-cc-xurls Katherine Cox-Buday
2023-02-06 22:34   ` ( via Guix-patches via
2023-01-18  1:44 ` [bug#60912] [PATCH 14/25] gnu: Add misspell Katherine Cox-Buday
2023-02-06 22:35   ` ( via Guix-patches via
2023-02-06 22:36   ` Christopher Baines
2023-02-07 17:53     ` Katherine Cox-Buday
2023-01-18  1:45 ` [bug#60914] [PATCH 15/25] gnu: Add go-github-com-client9-misspell Katherine Cox-Buday
2023-02-06 22:36   ` ( via Guix-patches via
2023-01-18  1:45 ` [bug#60913] [PATCH 16/25] gnu: Add go-github-com-google-go-cmdtest Katherine Cox-Buday
2023-02-06 23:05   ` ( via Guix-patches via
2023-01-18  1:45 ` [bug#60916] [PATCH 17/25] gnu: Add unparam Katherine Cox-Buday
2023-02-06 23:07   ` ( via Guix-patches via
2023-01-18  1:45 ` [bug#60915] [PATCH 18/25] gnu: Add go-mvdan-cc-unparam Katherine Cox-Buday
2023-02-06 23:07   ` ( via Guix-patches via
2023-01-18  1:45 ` [bug#60918] [PATCH 19/25] gnu: Add govulncheck Katherine Cox-Buday
2023-02-06 22:52   ` Christopher Baines
2023-02-07 17:56     ` Katherine Cox-Buday
2023-02-06 23:10   ` ( via Guix-patches via
2023-01-18  1:45 ` [bug#60919] [PATCH 20/25] gnu: Add go-golang-org-x-vuln Katherine Cox-Buday
2023-02-06 23:11   ` ( via Guix-patches via
2023-01-18  1:45 ` [bug#60917] [PATCH 21/25] gnu: go-github-com-burntsushi-toml: Update to 1.2.1 Katherine Cox-Buday
2023-02-06 23:12   ` ( via Guix-patches via
2023-01-18  1:45 ` [bug#60920] [PATCH 22/25] gnu: go-honnef-co-go-tools: Update to 0.3.3 Katherine Cox-Buday
2023-02-06 23:15   ` ( via Guix-patches via
2023-01-18  1:45 ` [bug#60922] [PATCH 23/25] gnu: Add gofumpt Katherine Cox-Buday
2023-02-06 23:17   ` ( via Guix-patches via
2023-01-18  1:45 ` [bug#60921] [PATCH 24/25] gnu: Add go-mvdan-cc-gofumpt Katherine Cox-Buday
2023-02-06 23:17   ` ( via Guix-patches via
2023-01-18  1:45 ` [bug#60899] [PATCH 25/25] gnu: Add gopls Katherine Cox-Buday
2023-02-06 23:28   ` ( via Guix-patches via
2023-01-30 16:53 ` Request for review of: [bug#60899] [PATCH 00/25] gnu: golang: " Katherine Cox-Buday
2023-02-06 16:53   ` [bug#60899] " Katherine Cox-Buday
2023-02-06 23:14 ` bug#60899: " Christopher Baines
2023-02-06 23:28   ` [bug#60899] " ( via Guix-patches via
2023-02-07  7:42     ` Christopher Baines
2023-02-07 16:02       ` Katherine Cox-Buday
2023-02-07 15:59   ` Katherine Cox-Buday

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=87357hxt2l.fsf@gmail.com \
    --to=cox.katherine.e@gmail.com \
    --cc=60910@debbugs.gnu.org \
    --cc=paren@disroot.org \
    /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.