| Aurimas Fišeras on Sun, 10 May 2009 14:03:20 +0200 |
[Date Prev] [Date Next] [Thread Prev] [Thread Next] [Date Index] [Thread Index]
| [PATCH] Some documentation fixes |
Hello, here are some small fixes to documentation found while reading it. Not sure if path 0004 is correct.
>From 39ec76d7daf8ecdbc0f6e7e078194b6b9ebb71e2 Mon Sep 17 00:00:00 2001
From: =?utf-8?q?Aurimas=20Fi=C5=A1eras?= <aurimas@gmail.com>
Date: Sun, 10 May 2009 14:04:01 +0300
Subject: close library after use as described in documentation
---
examples/extgcd.c | 1 +
1 files changed, 1 insertions(+), 0 deletions(-)
diff --git a/examples/extgcd.c b/examples/extgcd.c
index c127a61..a352c91 100644
--- a/examples/extgcd.c
+++ b/examples/extgcd.c
@@ -34,5 +34,6 @@ main()
printf("y = "); y = gp_read_stream(stdin);
d = extgcd(x, y, &u, &v);
pari_printf("gcd = %Ps\nu = %Ps\nv = %Ps\n", d, u, v);
+ pari_close();
return 0;
}
--
1.6.2.4
>From 849eabcd74acd84dc35e2a655255cd32233690c6 Mon Sep 17 00:00:00 2001
From: =?utf-8?q?Aurimas=20Fi=C5=A1eras?= <aurimas@gmail.com>
Date: Sun, 10 May 2009 14:06:25 +0300
Subject: polcoeff: fix typo in description
---
src/functions/polynomials/polcoeff | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/src/functions/polynomials/polcoeff b/src/functions/polynomials/polcoeff
index 14e4546..8d5d3a9 100644
--- a/src/functions/polynomials/polcoeff
+++ b/src/functions/polynomials/polcoeff
@@ -20,4 +20,4 @@ Doc: coefficient of degree $n$ of the polynomial $x$, with respect to the
message is issued.
For greater flexibility, vector or matrix types are also accepted for $x$,
- and the meaning is then identical with that of \kbd{compo(x,n}.
+ and the meaning is then identical with that of \kbd{component(x,n)}.
--
1.6.2.4
>From 15c9db4c4f4d43b142419ac3d224e76f2f13b99b Mon Sep 17 00:00:00 2001
From: =?utf-8?q?Aurimas=20Fi=C5=A1eras?= <aurimas@gmail.com>
Date: Sun, 10 May 2009 14:15:58 +0300
Subject: extern: fix typo
---
src/functions/programming/extern | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/src/functions/programming/extern b/src/functions/programming/extern
index 79783d1..5bbd46e 100644
--- a/src/functions/programming/extern
+++ b/src/functions/programming/extern
@@ -7,4 +7,4 @@ Help: extern(str): execute shell command str, and feeds the result to GP (as
if loading from file).
Doc: the string \var{str} is the name of an external command (i.e.~one you
would type from your UNIX shell prompt). This command is immediately run and
- its input fed into \kbd{gp}, just as if read from a file.
+ its output fed into \kbd{gp}, just as if read from a file.
--
1.6.2.4
>From e04913188995561d45aa2aaf884ef36648c96c08 Mon Sep 17 00:00:00 2001
From: =?utf-8?q?Aurimas=20Fi=C5=A1eras?= <aurimas@gmail.com>
Date: Sun, 10 May 2009 14:25:22 +0300
Subject: readvec: fix typo, \\ is used for comments, not to enter multiline sequences
---
src/functions/programming/readvec | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/src/functions/programming/readvec b/src/functions/programming/readvec
index 941680a..8b938e5 100644
--- a/src/functions/programming/readvec
+++ b/src/functions/programming/readvec
@@ -28,6 +28,6 @@ Doc: reads in the file
%5 = [1, 2, 3]
@eprog
In general a sequence is just a single line, but as usual braces and
- \kbd{\bs\bs} may be used to enter multiline sequences.
+ \kbd{\bs} may be used to enter multiline sequences.
Variant: The underlying library function
\fun{GEN}{gp_readvec_stream}{FILE *f} is usually more flexible.
--
1.6.2.4
>From 49eaa282edfb56f60ff1a145cfa836ae71be7275 Mon Sep 17 00:00:00 2001
From: =?utf-8?q?Aurimas=20Fi=C5=A1eras?= <aurimas@gmail.com>
Date: Sun, 10 May 2009 14:35:54 +0300
Subject: fix typo
---
doc/usersch4.tex | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/doc/usersch4.tex b/doc/usersch4.tex
index c321773..0ef512b 100644
--- a/doc/usersch4.tex
+++ b/doc/usersch4.tex
@@ -1037,7 +1037,7 @@ technical bit which indicates whether the object is a clone or not (see
\secref{se:clone}). This last one is used by \kbd{gp} for internal garbage
collecting, you will not have to worry about it.
-\noindent These data can be handled through the following \emph{macros}:
+\noindent This data can be handled through the following \emph{macros}:
\fun{long}{typ}{GEN z} returns the type number of \kbd{z}.
@@ -1333,7 +1333,7 @@ type has a second codeword. It contains a ``\emph{sign}'': 0 if the
polynomial is equal to~0, and 1 if not (see however the important remark
below) and a \emph{variable number} (e.g.~0 for $x$, 1 for $y$, etc\dots).
-\noindent These data can be handled with the following macros: \teb{signe}
+\noindent This data can be handled with the following macros: \teb{signe}
and \teb{setsigne} as for \typ{INT} and \typ{REAL},
\fun{long}{varn}{GEN z} returns the variable number of the object \kbd{z},
--
1.6.2.4
>From ac96087282eff06ac39f0904a66a966ad844ddfa Mon Sep 17 00:00:00 2001
From: =?utf-8?q?Aurimas=20Fi=C5=A1eras?= <aurimas@gmail.com>
Date: Sun, 10 May 2009 14:43:48 +0300
Subject: typos - make "pari" uppercase as in other places
---
doc/usersch4.tex | 4 ++--
doc/usersch5.tex | 8 ++++----
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/doc/usersch4.tex b/doc/usersch4.tex
index 0ef512b..faa38fe 100644
--- a/doc/usersch4.tex
+++ b/doc/usersch4.tex
@@ -1356,7 +1356,7 @@ For an object of type \typ{POL}, \tet{leading_term}, \tet{constant_term},
\tet{degpol} return a pointer to the leading term (with respect to the main
variable of course), constant term, and degree of the polynomial (with the
convention $\deg(0) = -1$). Applied to any other type, the result is
-unspecified. Note that no copy is made on the pari stack so the returned
+unspecified. Note that no copy is made on the PARI stack so the returned
value is not safe for a basic \kbd{gerepile} call. Note that $\kbd{degpol(z)}
= \kbd{lg(z)} - 3$.
@@ -1557,7 +1557,7 @@ that this may not be the same as \kbd{pol\_x(v)} if assignments have been
performed in the interpreter.
\subsubsec{Temporary variables}\sidx{variable (temporary)}:
-\kbd{MAXVARN} is available, but is better left to pari internal functions
+\kbd{MAXVARN} is available, but is better left to PARI internal functions
(some of which do not check that \kbd{MAXVARN} is free for them to use,
which can be considered a bug). You can create more temporary variables
using
diff --git a/doc/usersch5.tex b/doc/usersch5.tex
index cfb32d9..a0bd675 100644
--- a/doc/usersch5.tex
+++ b/doc/usersch5.tex
@@ -64,10 +64,10 @@ initialized with \kbd{pari\_init}) and frees all allocated objects.
\kbd{pari\_init}, more flexible. \kbd{opts} is a mask of flags
among the following:
- \kbd{INIT\_JMPm}: install pari error handler. When an exception is
+ \kbd{INIT\_JMPm}: install PARI error handler. When an exception is
raised, the program is terminated with \kbd{exit(1)}.
- \kbd{INIT\_SIGm}: install pari signal handler.
+ \kbd{INIT\_SIGm}: install PARI signal handler.
\kbd{INIT\_DFTm}: initialize the \kbd{GP\_DATA} environment structure.
This one \emph{must} be enabled once. If you close pari, then restart it,
@@ -79,7 +79,7 @@ for a library initialized with a mask of options using
\kbd{pari\_init\_opts}. \kbd{opts} is a mask of flags among
\kbd{INIT\_SIGm}: restore \kbd{SIG\_DFL} default action for signals
-tampered with by pari signal handler.
+tampered with by PARI signal handler.
\kbd{INIT\_DFTm}: frees the \kbd{GP\_DATA} environment structure.
@@ -123,7 +123,7 @@ a function, it has at least the following fields:
\kbd{char *help} : the help text for the function.
A routine in GP is described to the analyzer by an \kbd{entree}
-structure. Built-in pari routines are grouped in \emph{modules}, which
+structure. Built-in PARI routines are grouped in \emph{modules}, which
are arrays of \kbd{entree} structs, the last of which satisfy
\kbd{name = NULL} (sentinel).
--
1.6.2.4