Menu
▾
▴
#378 Missing documentation entries and index entries
ABS is not documented (though it's used in several
places in the doc).
LAMBDA is not in the index. Of course, it is not a normal
function, but it would be good to index it.
UND and IND don't have index entries. Even though only
LIMIT (currently) uses them, they should probably be
indexed (even if the index entry points to LIMIT).
The relational operators aren't indexed (<, >, <=, >=),
though they are described in the INEQUALITY section.
The arithmetic operators aren't indexed (+, -, /) -- are
they even documented anywhere?
LI, the log integral, is not documented, though it is
returned by integrate(log(1-x)/x,x) for example.
There is some sort of indexing error for "[" -- instead of
going to the list section, it goes to the Special Function
section.
There are no index entries for AND, OR, and NOT, which
are only defined apparently under IF, even though they
are meaningful outside it, e.g.
true and false => false
Logged In: YES
user_id=501686
Here are some more documentation items that appear to be
lacking:
- Tensor.texi: entry for CANFORM refers to "example under
DECSYM" but there is no entry for DECSYM
- Matrices.texi: says to DESCRIBE("^^"); but no such
documentation
- Quoting a conditional, e.g., "'if x > 5 then a else b"
yields 'COND(x > 5, a, TRUE, b), but COND is not documented
- Runtime.texi: says to DESCRIBE(CHARACTERS); but no such
documentation
- Affine.texi: "See DECLARE_WEIGHTS", but no such documentation
- Number.texi: "see %GAMMA", but no such documentation
- Special.texi: "see POLYGAMMA" but no such function nor
doc entry maybe some other related topic can be referenced
- xrefs.texi: "See POLYLOGARITHMS" -- can't find any such
topic, however, there appears to be some stuff related to
polylogarithms in risch.lisp
- There is a defun $printfile (mload.lisp) but no
documentation for PRINTFILE
- Trigonometric.texi: discussion under "Introduction to
Trigonometric" refers to NTRIG, but no such documentation;
there is a package share/trigonometry/ntrig.mac and also
share/trigonometry/ntrig.usg; also there is a section for
NTRIG in None.texi -- does this mean someone meant to
clobber the NTRIG package?
Logged In: YES
user_id=501686
At present (maxima 5.9.3):
---------------------------------
--Stuff that is OK as it stands--
---------------------------------
abs, lambda, li, and, or, not, decsym, gamma, ntrig -- now
have documentation items (although abs is very short)
characters -- ? characters yields some useful stuff, and
Runtime.texi no longer mentions describe(characters)
---------------------------------
------Stuff that needs work------
---------------------------------
<, <=, >=, > -- mentioned under inequalities and if but they
should have their own items); = and # have their own items
und ind + - * / [ ^^ declare_weights printfile -- no
documentation items for these
---------------------------------
--Stuff that we can ignore now---
---------------------------------
cond -- not something we want to document (noun 'if now
displays as if or 'if, not cond)
polygamma -- no longer mentioned
polylogarithms -- xrefs.texi cut out entirely (obsolete)
Logged In: YES
user_id=501686
Originator: NO
All items mentioned in this report and follow-up comments are now covered at least briefly in the reference manual. Some of these items were done a long time ago and some just now. Closing this report as fixed.