[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: * doc/texinfo.texi (Optional Arguments): do not p
From: |
Patrice Dumas |
Subject: |
branch master updated: * doc/texinfo.texi (Optional Arguments): do not present the use of brackets, parentheses and ellipses presented here as the unique convention, but a convenient style. Remove information on index, it is not the subject of this node. |
Date: |
Sat, 13 Aug 2022 02:29:59 -0400 |
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 dd84c3069a * doc/texinfo.texi (Optional Arguments): do not present the
use of brackets, parentheses and ellipses presented here as the unique
convention, but a convenient style. Remove information on index, it is not the
subject of this node.
dd84c3069a is described below
commit dd84c3069a3239b5ab08d73d7941ce8000a161e1
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sat Aug 13 08:29:47 2022 +0200
* doc/texinfo.texi (Optional Arguments): do not present the use of
brackets, parentheses and ellipses presented here as the unique
convention, but a convenient style. Remove information on index,
it is not the subject of this node.
* doc/texinfo.texi (Typed Functions): in the example with named return
variable, add an example of referring to a variable in the definition
body.
---
ChangeLog | 13 ++++++++++++-
doc/texinfo.texi | 10 +++-------
2 files changed, 15 insertions(+), 8 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 43ef3ddde8..f4655f7ebf 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,4 +1,15 @@
-2022-08-11 Patrice Dumas <pertusus@free.fr>
+2022-08-13 Patrice Dumas <pertusus@free.fr>
+
+ * doc/texinfo.texi (Optional Arguments): do not present the use of
+ brackets, parentheses and ellipses presented here as the unique
+ convention, but a convenient style. Remove information on index,
+ it is not the subject of this node.
+
+ * doc/texinfo.texi (Typed Functions): in the example with named return
+ variable, add an example of referring to a variable in the definition
+ body.
+
+2022-08-12 Patrice Dumas <pertusus@free.fr>
@deftype* as generic commands, @deffn with simple arguments
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 01b571a07c..f1e85dddfd 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -11497,7 +11497,7 @@ character (space, tab, newline) produces a normal
interword space
@cindex Meta-syntactic chars for arguments
@c This is consistent with the Emacs Lisp Reference Manual.
-Some entities take optional or repeated arguments, conventionally
+Entities optional or repeated arguments are conveniently
specified by using square brackets and ellipses: an argument enclosed
within square brackets is optional, and an argument followed by an
ellipsis is optional and may be repeated more than once.
@@ -11530,10 +11530,6 @@ this:
@@defspec foobar (var [from to [inc]]) body@@dots@{@}
@end example
-@noindent
-The function is listed in the Command and Variable Index under
-@samp{foobar}.
-
@node @code{@@deffnx}
@section @code{@@deffnx}, et al.: Two or More `First' Lines
@@ -11803,14 +11799,14 @@ variables. For example, in Perl, returned scalars may
be given the
@example
@@deftypefn @{Sub@} @{(@@var@{$result@}, @@var@{$status@})@} @@
process (@@var@{$input@})
-@dots{}
+@dots{} Set @@var@{$status@} to 0 in case of failure @dots{}
@@end deftypefn
@end example
to get output like
@deftypefn {Sub} {(@var{$result}, @var{$status})} process (@var{$input})
-@dots{}
+@dots{} Set @var{$status} to 0 in case of failure @dots{}
@end deftypefn
@code{@@deftypefn} creates an entry in the index of functions for
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- branch master updated: * doc/texinfo.texi (Optional Arguments): do not present the use of brackets, parentheses and ellipses presented here as the unique convention, but a convenient style. Remove information on index, it is not the subject of this node.,
Patrice Dumas <=