* vc docstrings
@ 2009-03-12 23:31 Miles Bader
2009-03-13 16:06 ` Stefan Monnier
0 siblings, 1 reply; 2+ messages in thread
From: Miles Bader @ 2009-03-12 23:31 UTC (permalink / raw
To: emacs-devel
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
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: vc docstrings
2009-03-12 23:31 vc docstrings Miles Bader
@ 2009-03-13 16:06 ` Stefan Monnier
0 siblings, 0 replies; 2+ messages in thread
From: Stefan Monnier @ 2009-03-13 16:06 UTC (permalink / raw
To: Miles Bader; +Cc: emacs-devel
> Given that all commonly used source-control systems these days are
> the "merging" type, shouldn't the section on "merging systems" be first?
Yes. It may even present itself as "the way it works" and the locking
version only presented as an exception at the end.
> 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.]
Better list the locking ones, it's less likely to change over time.
Stefan
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2009-03-13 16:06 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-03-12 23:31 vc docstrings Miles Bader
2009-03-13 16:06 ` Stefan Monnier
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.