texinfo-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[no subject]


From: Gavin D. Smith
Date: Fri, 10 Feb 2023 21:24:27 -0500 (EST)

branch: master
commit 0ea7f1b934a733ad0852410f955e74ebe246d3bf
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Sat Feb 11 02:22:57 2023 +0000

    * doc/texinfo.texi (Typed Functions):
    Place R language example in @ignore block as @var uppercases
    named arguments in Info output.
---
 ChangeLog        |  6 ++++++
 doc/texinfo.texi | 10 ++++++++--
 2 files changed, 14 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index e8a5c4d19f..b91cde12eb 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2023-02-11  Gavin Smith <gavinsmith0123@gmail.com>
+
+       * doc/texinfo.texi (Typed Functions):
+       Place R language example in @ignore block as @var uppercases
+       named arguments in Info output.
+
 2023-02-11  Gavin Smith <gavinsmith0123@gmail.com>
 
        * doc/texinfo.tex (@defblock, @deflinex, @deftypelinex):
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 4aebcc7981..41483d6205 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -11651,8 +11651,12 @@ is @code{push}, and its arguments are @var{s} and 
@var{n}.)  Output:
 interpret the arguments list as literal computer code, marking
 argument names with @code{@@var}.
 It is not necessary for any type names to appear,
-and you can give an empty return type as @samp{@{@}}.  For
-example, for documenting the R language, you could use input like
+and you can give an empty return type as @samp{@{@}}.
+
+@ignore
+@c This example is flawed because @var uppercases in Info output,
+@c which is inappropriate for named arguments
+For example, for documenting the R language, you could use input like
 
 @example
 @@deftypefn stats @{@} t.test (@@var@{x@}, @@var@{y@} = NULL,@@
@@ -11676,6 +11680,8 @@ example, for documenting the R language, you could use 
input like
 
 @noindent Here the @code{@@w} command is used to prevent some line breaks.
 
+@end ignore
+
 The information on return values may be used to name the return
 variables. For example, in Perl, returned scalars may be given the
 @var{$result} and @var{$status} name in the following manner:



reply via email to

[Prev in Thread] Current Thread [Next in Thread]