Mercurial > hg > octave-nkf
diff doc/interpreter/tips.txi @ 10791:3140cb7a05a1
Add spellchecker scripts for Octave and run spellcheck of documentation
interpreter/doccheck: New directory for spelling/grammar scripts.
interpreter/doccheck/README: Instructions for using scripts.
interpreter/doccheck/spellcheck: Script to spellcheck a Texinfo file.
interpreter/doccheck/aspell.conf: GNU Aspell configuration file for
Octave documentation.
interpreter/doccheck/aspell-octave.en.pws: Private Aspell dictionary.
interpreter/doccheck/add_to_aspell_dict: Script to add new
Octave-specific words to
private Aspell dictionary.
interpreter/octave.texi: New @nospell macro which forces Aspell
to ignore the word marked by the macro.
interpreter/mk_doc_cache.m: Skip new @nospell macro when building
doc_cache.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sat, 17 Jul 2010 19:53:01 -0700 |
parents | c3df189b1b15 |
children | 5b68000faac1 |
line wrap: on
line diff
--- a/doc/interpreter/tips.txi +++ b/doc/interpreter/tips.txi @@ -202,7 +202,7 @@ Sometimes the number of items can't be computed in advance, and stack-like operations are needed. When elements are being repeatedly inserted at/removed from the end of an array, Octave detects it as stack usage and attempts to use a smarter memory management -strategy preallocating the array in bigger chunks. Likewise works for cell and +strategy pre-allocating the array in bigger chunks. Likewise works for cell and struct arrays. @example @@ -518,7 +518,7 @@ functions. The important aspects of the documentation string are @table @asis -@item -*- texinfo -*- +@item -*- @nospell{texinfo} -*- This string signals Octave that the following text is in Texinfo format, and should be the first part of any help string in Texinfo format. @item @@deftypefn@{class@} @dots{} @@end deftypefn @@ -545,7 +545,7 @@ with text terminals as well as generating high-quality printed output. To these ends, Texinfo has commands which control the diversion of parts of the document into a particular output processor. Three formats are -of importance: info, html and @TeX{}. These are selected with +of importance: info, HTML and @TeX{}. These are selected with @example @group @@ -571,7 +571,7 @@ @end group @end example -Note that often @TeX{} output can be used in html documents and so often +Note that often @TeX{} output can be used in HTML documents and so often the @code{@@ifhtml} blocks are unnecessary. If no specific output processor is chosen, by default, the text goes into all output processors. It is usual to have the above blocks in pairs to allow the