GNU bug report logs - #65386
[PATCH] ; Refine some 'package-vc' docstrings

Previous Next

Package: emacs;

Reported by: Eshel Yaron <me <at> eshelyaron.com>

Date: Sat, 19 Aug 2023 18:08:02 UTC

Severity: normal

Tags: patch

Fixed in version 30.1

Done: Philip Kaludercic <philipk <at> posteo.net>

Bug is archived. No further changes may be made.

Full log


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

From: Eshel Yaron <me <at> eshelyaron.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: philipk <at> posteo.net, 65386 <at> debbugs.gnu.org
Subject: Re: bug#65386: [PATCH] ; Refine some 'package-vc' docstrings
Date: Sun, 20 Aug 2023 09:15:08 +0200
[Message part 1 (text/plain, inline)]
Hi,

>> > What is the significance of "from source" here?
>>
>> It's just for indicating that we're talking about VC packages
>> specifically.  Does that make sense?
>
> Then how about
>
>   List of packages to install from their VCS repositories.
>

SGTM, updated in the new patch (v3) I've attached below.

>> >> +  "Send patch for REVISIONS to maintainer of the package PKG-DESC using SUBJECT.
>> >
>> > This should mention email, otherwise SUBJECT is confusing.  Maybe use
>> > "Email" instead of "Send".
>>
>> Alright, I made a couple more changes to this one.
>
> Now you have lost the reference to SUBJECT.  Was that necessary?  We
> generally try to mention all the mandatory arguments in the first line
> of the doc string.  The sentence below seems to be squeezable into 79
> columns:
>
>   Email patches for REVISIONS to maintainer of package PKG-DESC using SUBJECT.
>
> (Dropping articles is a frequent trick to make the first line fit.)

Nicely squeezed :) I've adopted your phrasing in the patch below.

[v3-0001-Refine-some-package-vc-docstrings.patch (text/x-patch, attachment)]

This bug report was last modified 1 year and 359 days ago.

Previous Next


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