On Thu, 05 May 2011 11:12:50 +0200, Štěpán Němec <[email protected]> wrote:
>
>
> Pieter Praet <[email protected]> writes:
> > diff --git a/magit.texi b/magit.texi
> > index 4c123a4..423f298 100644
> > --- a/magit.texi
> > +++ b/magit.texi
> > @@ -655,9 +655,10 @@ associated with rewriting. These commands all start
> > with the @kbd{r}
> > prefix key.
> >
> > Typing @kbd{r b} will start a rewrite operation. You will be prompted
> > -for a @emph{base} commit, and all commits between the current head and
> > -this commit are put in a list of @emph{Pending commits}. The current
> > -head will then be reset to the base commit.
> > +for a @emph{base} commit. This commit and all subsequent commits up
> > +until the current head are then put in a list of @emph{Pending
> > +commits}, after which the current head will be reset to the
> > +@emph{parent} of the base commit.
>
> IMO you should mention the new variable here. [...]
I actually considered that, but was in a bit of a hurry.
Since I've already issued a pull request, perhaps it's better to wait
for it to be merged in before further amending the documentation.
Moreover, a quick check revealed that less than 25% of defcustom
variables are mentioned in the docs, and various keybinds and related
switches are either incorrect or missing.
How about automatically generating docs from inline documentation in the
source? The (supposedly) only cartoon RMS has ever drawn [1]
specifically calls Emacs a "Self-Documenting extensible editor" [sic]
for good reason. :D
> [...] (And I'd say "up to"
> instead of "up until", but I'm not a native speaker.)
I'm not a native speaker either (although I consider English vastly
superior to my native tongues, and act accordingly) but I'd say that
depends on whether you regard the commit series as either a spatial or a
chronological vector.
You're most welcome to change it if you like, though. :)
>
> Štěpán
>
Peace
--
Pieter
[1] http://www.gnu.org/software/emacs/self-doc-extensible-editor.png
