#468 minor documentation bugs w/ uncontroversial fixes

closed
nobody
5
2004-10-31
2003-12-10
No

Here is a list of minor bugs in documentation files
that can be fixed without controversy, I think. Pretty
soon I hope to post a patch file which has the file
names and line numbers and exact text.

- DESCRIBE(EXAMPLE)$ claims that the default value for
manual_demo is "maxima.demo" but it is actually
"manual.demo" (in 2003112x cvs)

- Equations.texi: entry for IEQN claims that IEQN will
do a KILL(LABELS) but in fact that's commented out of
the source code -- strike "CAVEAT: ... he wants to keep."

- 'describe' -> 'DESCRIBE', and 'example' -> 'EXAMPLE':
Help.texi:short cut you may type @code{? fact} in
lieu of
@code{describe("fact")}
Help.texi:example(integrate);
Help.texi:(C4) example(integrate);
Help.texi:(C1) describe("integ");
Introduction.texi:(C1) describe(factor);

- Ctensor.texi: DESCRIBE(CTENSR) -> DESCRIBE(CTENSOR)

- Integration.texi: split into 2 DESCRIBE's:
DESCRIBE(ROMBERGABS,ROMBERGMIN);

- xrefs.texi: DESCRIBE(INTEGRALS); doesn't mention
general integration (instead it mentions elliptic
integrals); INTEGRALS -> INTEGRATE

- Ctensor.texi, tensor/info-tensor.txt, tensor/manual.txt,
tensor/tensor-doc.txt: "TENSOR;METRIC FILE" ->
"tensor/metrics.mac"

- Expressions.texi: INTEGRAL -> integral -- there is
no symbol '$integral' or '$INTEGRAL'

- Floating.texi: LOAD(BFAC) -> LOAD(BFFAC)
also: share2/bfac.usg -> share/numeric/bffac.usg
also: CBFAC -> CBFFAC

- Input.texi: init.lsp -> src/init-cl.lisp

- Miscellaneous.texi: "see Appendix II" -- none such,
strike it

- Operators.texi: "see the file SHARE2;SUBLIS INFO" --
none such, strike it

- Trigonometric.texi: "see the POISSIMP function
(6.6)" --
the "(6.6)" doesn't make any sense at present; was
it a section number way back when? -- Strike "(6.6)"

- xrefs.texi: strike "@section STORAGE--see
:gargbage_collection" (mispelled, and a broken link
even if not mispelled)

Discussion

  • Robert Dodier

    Robert Dodier - 2004-10-31

    Logged In: YES
    user_id=501686

    Resolved by committing changes to Ctensor.texi,
    Equations.texi, Expressions.texi, Floating.texi, Help.texi,
    Input.texi, Integration.texi, Miscellaneous.texi,
    Operators.texi, and Trigonometric.texi.

    xrefs.texi was ignored, same with share/tensor/* files.

     
  • Robert Dodier

    Robert Dodier - 2004-10-31
    • status: open --> closed
     

Log in to post a comment.

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks