Sam Steingold on Wed, 13 Dec 2017 17:16:38 +0100 |
[Date Prev] [Date Next] [Thread Prev] [Thread Next] [Date Index] [Thread Index]
a patch to fix optional arg notation in help |
The notation (a,{b}) is used throughout the docs except these 4 cases. This makes it hard to parse pari.desc to generate FFI.
>From a92a2d82c53f4ddf74a240f19980964e5023813b Mon Sep 17 00:00:00 2001 From: Sam Steingold <sds@gnu.org> Date: Wed, 13 Dec 2017 11:11:43 -0500 Subject: [PATCH] Use the standard (a,{b}) notation for optional argument. --- src/functions/number_theoretical/ffnbirred | 2 +- src/functions/programming/dbg_x | 2 +- src/functions/programming/iferr | 3 +-- src/functions/symbolic_operators/coeff | 2 +- 4 files changed, 4 insertions(+), 5 deletions(-) diff --git a/src/functions/number_theoretical/ffnbirred b/src/functions/number_theoretical/ffnbirred index 117af0d9b..7b9aee4ab 100644 --- a/src/functions/number_theoretical/ffnbirred +++ b/src/functions/number_theoretical/ffnbirred @@ -2,7 +2,7 @@ Function: ffnbirred Section: number_theoretical C-Name: ffnbirred0 Prototype: GLD0,L, -Help: ffnbirred(q,n{,fl=0}): number of monic irreducible polynomials over F_q, of +Help: ffnbirred(q,n,{fl=0}): number of monic irreducible polynomials over F_q, of degree n (fl=0, default) or at most n (fl=1). Description: (int, small, ?0):int ffnbirred($1, $2) diff --git a/src/functions/programming/dbg_x b/src/functions/programming/dbg_x index 08d688035..b1a4c4331 100644 --- a/src/functions/programming/dbg_x +++ b/src/functions/programming/dbg_x @@ -2,7 +2,7 @@ Function: dbg_x Section: programming/control C-Name: dbgGEN Prototype: vGD-1,L, -Help: dbg_x(A{,n}): print inner structure of A, complete if n is omitted, up to +Help: dbg_x(A,{n}): print inner structure of A, complete if n is omitted, up to level n otherwise. Intended for debugging. Doc: Print the inner structure of \kbd{A}, complete if \kbd{n} is omitted, up to level \kbd{n} otherwise. This is useful for debugging. This is similar to diff --git a/src/functions/programming/iferr b/src/functions/programming/iferr index 16c113293..f4cc3b8aa 100644 --- a/src/functions/programming/iferr +++ b/src/functions/programming/iferr @@ -30,7 +30,7 @@ Function: iferr Section: programming/control C-Name: iferrpari Prototype: EVEDE -Help: iferr(seq1,E,seq2{,pred}): evaluates the expression sequence seq1. If +Help: iferr(seq1,E,seq2,{pred}): evaluates the expression sequence seq1. If an error occurs, set the formal parameter E set to the error data. If pred is not present or evaluates to true, catch the error and evaluate seq2. Both pred and seq2 can reference E. @@ -229,4 +229,3 @@ Doc: evaluates the expression sequence \var{seq1}. If an error occurs, not exist, in function $s$. (As in \kbd{sqrt(Mod(-1,3))}.) \var{E} has two components, 1 (\typ{STR}): the function name $s$, 2: the argument $x$. - diff --git a/src/functions/symbolic_operators/coeff b/src/functions/symbolic_operators/coeff index 3061f86f5..270897759 100644 --- a/src/functions/symbolic_operators/coeff +++ b/src/functions/symbolic_operators/coeff @@ -1,6 +1,6 @@ Function: _[_,_] Section: symbolic_operators -Help: x[i{,j}]: i coefficient of a vector, i,j coefficient of a matrix +Help: x[i,{j}]: i coefficient of a vector, i,j coefficient of a matrix Description: (mp,small):gen $"Scalar has no components" (mp,small,small):gen $"Scalar has no components" -- 2.15.1
Thanks. -- Sam Steingold (http://sds.podval.org/) on darwin Ns 10.3.1504 http://steingoldpsychology.com http://www.childpsy.net http://jij.org http://www.memritv.org http://mideasttruth.com http://americancensorship.org You can't explain puns to kleptomaniacs because they take things literally.