From: Miles Bader <miles@gnu.org>
To: emacs-devel@gnu.org
Subject: vc docstrings
Date: Fri, 13 Mar 2009 08:31:17 +0900 [thread overview]
Message-ID: <87r612mi7u.fsf@catnip.gol.com> (raw)
I notice `vc-next-action' has a docstring of the form:
SHORT_DESCRIPTION
For locking systems:
... LONG DESCRIPTION FOR LOCKING VCS
For merging systems:
... LONG DESCRIPTION FOR MERGING VCS
Given that all commonly used source-control systems these days are
the "merging" type, shouldn't the section on "merging systems" be first?
Also, I think many users are probably only vaguely aware that there _is_
such a distinction (how many people these days have ever used RCS?), so
perhaps it would be a good idea to give a list of common systems of each
type directly in the comment.
E.g., change the "merging systems" header to:
For merging systems (CVS, Subversion, Git, Bzr, Hg, Arch):
[Maybe similar comments apply to other vc-... commands too.]
Thanks,
-Miles
--
"Most attacks seem to take place at night, during a rainstorm, uphill,
where four map sheets join." -- Anon. British Officer in WW I
next reply other threads:[~2009-03-12 23:31 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-03-12 23:31 Miles Bader [this message]
2009-03-13 16:06 ` vc docstrings Stefan Monnier
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=87r612mi7u.fsf@catnip.gol.com \
--to=miles@gnu.org \
--cc=emacs-devel@gnu.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/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.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.