Re: emacs-26 de17b8e: Tiny doc/misc markup fixes

Re: emacs-26 de17b8e: Tiny doc/misc markup fixes

[Robert Pluim]

rgm@gnu.org (Glenn Morris) writes:

> @@ -4069,7 +4069,7 @@ The variable @code{viper-read-buffer-function} controls which function is
>  actually used to read the buffer name. The default is @code{read-buffer},
>  but better alternatives are also available in Emacs (e.g.,
>  @code{ido-read-buffer}).
> -@vindex @var{viper-read-buffer-function}
> +@vindex @code{viper-read-buffer-function}
>  @item :B
>  Like @kbd{:b}, but the meaning of @code{ex-cycle-other-window} is reversed.
>  @item :<address>r <name>

Does @vindex actually require any markup on the variable name? Most of
its uses in the emacs documentation have no markup at all (although
@var is definitely wrong).

Robert

Re: emacs-26 de17b8e: Tiny doc/misc markup fixes

[Michael Albinus]

Robert Pluim <rpluim@gmail.com> writes:

> Does @vindex actually require any markup on the variable name? Most of
> its uses in the emacs documentation have no markup at all (although
> @var is definitely wrong).

I believe @findex and @vindex are defined using @defcodeindex, so
there's no need to markup the entries.

OTOH, @cindex is defined as @defindex, so we should mark symbols and
alike.

For discussion, see "(texinfo) New Indices".

I will go through the manual(s), and remove markups in @findex and
@vindex entries.

> Robert

Best regards, Michael.

Re: emacs-26 de17b8e: Tiny doc/misc markup fixes

[Eli Zaretskii]

> From: Michael Albinus <michael.albinus@gmx.de>
> Date: Fri, 23 Feb 2018 10:57:57 +0100
> Cc: Glenn Morris <rgm@gnu.org>
> 
> Robert Pluim <rpluim@gmail.com> writes:
> 
> > Does @vindex actually require any markup on the variable name? Most of
> > its uses in the emacs documentation have no markup at all (although
> > @var is definitely wrong).
> 
> I believe @findex and @vindex are defined using @defcodeindex, so
> there's no need to markup the entries.

Indeed, there's no need.  But viper.texi does this for all the index
entries, so all of them should be fixed.  Patches welcome.

> I will go through the manual(s), and remove markups in @findex and
> @vindex entries.

Thanks.

Re: emacs-26 de17b8e: Tiny doc/misc markup fixes

[Michael Albinus]

Eli Zaretskii <eliz@gnu.org> writes:

>> I believe @findex and @vindex are defined using @defcodeindex, so
>> there's no need to markup the entries.
>
> Indeed, there's no need.  But viper.texi does this for all the index
> entries, so all of them should be fixed.  Patches welcome.

OTOH, non-code parts of @findex and @vindex must be marked with
@r{}. Sometimes this is done, sometimes not. Will fix this as well.

>> I will go through the manual(s), and remove markups in @findex and
>> @vindex entries.

I'm almost ready. Expect my patch later today.

> Thanks.

Best regards, Michael.