branch master updated: Document that &word should be marked explicitly on @def* lines

[Patrice Dumas]

This is an automated email from the git hooks/post-receive script.

pertusus pushed a commit to branch master
in repository texinfo.

The following commit(s) were added to refs/heads/master by this push:
     new 5f81b4f7a2 Document that &word should be marked explicitly on @def* 
lines
5f81b4f7a2 is described below

commit 5f81b4f7a2f046704a12092d7c6f48d92acadf7c
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sat Jul 30 00:33:37 2022 +0200

    Document that &word should be marked explicitly on @def* lines
    
    * doc/texinfo.texi (Def Cmd Conventions, Sample Function Definition):
    document that &word should be marked explicitly on the @def*
    line if it is to be strongly emphasized.  It is only done
    automatically in TeX and this feature will be removed in the future.
---
 ChangeLog        |  9 +++++++++
 doc/texinfo.texi | 13 ++++++++++---
 2 files changed, 19 insertions(+), 3 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index c9fd0d6265..bd0f19f5cd 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2022-07-29  Patrice Dumas  <pertusus@free.fr>
+
+       Document that &word should be marked explicitly on @def* lines
+
+       * doc/texinfo.texi (Def Cmd Conventions, Sample Function Definition):
+       document that &word should be marked explicitly on the @def*
+       line if it is to be strongly emphasized.  It is only done
+       automatically in TeX and this feature will be removed in the future.
+
 2022-07-29  Patrice Dumas  <pertusus@free.fr>
 
        Only @r stops upright. Propagate upright in non slanted
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 097be10ded..8df362866f 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -12260,6 +12260,13 @@ to the @code{forward-word} function.  Also, if the 
name of an argument
 contains the name of a type, such as @var{integer}, take care that the
 argument actually is of that type.
 
+In @TeX{}, @samp{&@var{keyword}} in definition @@-command arguments is
+rendered in bold typeface with the following word.  If such a formatting is
+desired, it is better to mark the keyword explicitly, with
+@code{@@r@{@@b@{&keyword@}@}} because this formatting is not done in
+any other output format, and also because in the future this feature
+should be removed.
+
 
 @node Sample Function Definition
 @section A Sample Function Definition
@@ -12277,7 +12284,7 @@ Here is a definition from @ref{Calling Functions,,, 
elisp, The GNU Emacs
 Lisp Reference Manual}.
 
 @quotation
-@defun apply function &rest arguments
+@defun apply function @r{@b{&rest}} arguments
 @code{apply} calls @var{function} with @var{arguments}, just
 like @code{funcall} but with one difference: the last of
 @var{arguments} is a list of arguments to give to
@@ -12308,11 +12315,11 @@ of @code{mapcar}.
 @end defun
 @end quotation
 
-In the Texinfo source file, this example looks like this:
+In the Texinfo source file, this example should look like this:
 
 @example
 @group
-@@defun apply function &rest arguments
+@@defun apply function @@r@{@@strong@{&rest@}@} arguments
 @@code@{apply@} calls @@var@{function@} with
 @@var@{arguments@}, just like @@code@{funcall@} but with one
 difference: the last of @@var@{arguments@} is a list of