Mercurial > hg > octave-lyh
changeset 16790:d21bf69e49b2
doc: Update some spacing in the Tips & Standards chapter.
* doc/interpreter/tips.txi: Add space after deftypefn in examples
since this is preferred in real code.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 20 Jun 2013 18:12:17 -0700 |
parents | 2f63d2f3ff11 |
children | acd6a21259a9 |
files | doc/interpreter/tips.txi |
diffstat | 1 files changed, 5 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/tips.txi +++ b/doc/interpreter/tips.txi @@ -347,7 +347,7 @@ @example @group -*- texinfo -*- -@@deftypefn@{Function File@} @{@@var@{ret@} =@} fn (@dots{}) +@@deftypefn @{Function File@} @{@@var@{ret@} =@} fn (@dots{}) @@cindex index term Help text in Texinfo format. Code samples should be marked like @@code@{sample of code@} and variables should be marked @@ -366,7 +366,7 @@ 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 +@item @@deftypefn @{class@} @dots{} @@end deftypefn The entire help string should be enclosed within the block defined by deftypefn. @@ -394,7 +394,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 @@ -477,8 +477,8 @@ @example @group -*- texinfo -*- -@@deftypefn @{Function File@} @{@@var@{a@} =@} fn (@@var@{x@}, @dots{}) -@@deftypefnx@{Function File@} @{@@var@{a@} =@} fn (@@var@{y@}, @dots{}) +@@deftypefn @{Function File@} @{@@var@{a@} =@} fn (@@var@{x@}, @dots{}) +@@deftypefnx @{Function File@} @{@@var@{a@} =@} fn (@@var@{y@}, @dots{}) Help text in Texinfo format. @@end deftypefn @end group