unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Eshel Yaron <me@eshelyaron.com>
Cc: philipk@posteo.net, 65386@debbugs.gnu.org
Subject: bug#65386: [PATCH] ; Refine some 'package-vc' docstrings
Date: Sun, 20 Aug 2023 09:05:49 +0300	[thread overview]
Message-ID: <83h6ouxn7m.fsf@gnu.org> (raw)
In-Reply-To: <m1a5umhige.fsf@eshelyaron.com> (message from Eshel Yaron on Sat,  19 Aug 2023 22:42:57 +0200)

> From: Eshel Yaron <me@eshelyaron.com>
> Cc: 65386@debbugs.gnu.org,  philipk@posteo.net
> Date: Sat, 19 Aug 2023 22:42:57 +0200
> 
> >> -(defcustom package-vc-selected-packages '()
> >> -  "List of packages that must be installed.
> >> -Each member of the list is of the form (NAME . SPEC), where NAME
> >> -is a symbol designating the package and SPEC is one of:
> >> +
> >> +(defcustom package-vc-selected-packages nil
> >> +  "List of packages to install from source.
> >
> > 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.

> >> +  "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.)





  reply	other threads:[~2023-08-20  6:05 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-08-19 18:07 bug#65386: [PATCH] ; Refine some 'package-vc' docstrings Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-19 19:47 ` Eli Zaretskii
2023-08-19 20:42   ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-20  6:05     ` Eli Zaretskii [this message]
2023-08-20  7:15       ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-20  8:32         ` Philip Kaludercic
2023-08-20 10:14           ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-20 12:18             ` Philip Kaludercic
2023-08-20 14:44               ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-20 16:04                 ` Philip Kaludercic
2023-08-20 16:22                   ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-20 18:33                     ` Philip Kaludercic
2023-08-20 10:31           ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-20  8:13     ` Philip Kaludercic
2023-08-20 19:24 ` Mauro Aranda
2023-08-20 20:35   ` Philip Kaludercic
2023-08-21  8:16     ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-21  9:27       ` Philip Kaludercic
2023-08-21 10:22         ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
     [not found] <87ledwipkb.fsf@posteo.net>
2023-08-27 17:18 ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-29  8:43   ` Philip Kaludercic
2023-08-29  9:10     ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors

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

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83h6ouxn7m.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=65386@debbugs.gnu.org \
    --cc=me@eshelyaron.com \
    --cc=philipk@posteo.net \
    /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 public inbox

	https://git.savannah.gnu.org/cgit/emacs.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).