Mercurial > hg > octave-lyh

comparison doc/interpreter/tips.txi @ 7001:8b0cfeb06365

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2007-10-10 18:02:59 by jwe]
author jwe
date Wed, 10 Oct 2007 18:03:02 +0000
parents 083721ae3dfa
children 93c65f2a5668
comparison
equal deleted inserted replaced
7000:e87f860624cc 7001:8b0cfeb06365
273 @node Documentation Tips 273 @node Documentation Tips
274 @section Tips for Documentation Strings 274 @section Tips for Documentation Strings
275 275
276 As noted above, documentation is typically in a commented header block 276 As noted above, documentation is typically in a commented header block
277 on an Octave function following the copyright statement. The help string 277 on an Octave function following the copyright statement. The help string
278 shown above is an unformated stringed and will be displayed as is by 278 shown above is an unformatted string and will be displayed as is by
279 Octave. Here are some tips for the writing of documentation strings. 279 Octave. Here are some tips for the writing of documentation strings.
280 280
281 @itemize @bullet 281 @itemize @bullet
282 @item 282 @item
283 Every command, function, or variable intended for users to know about 283 Every command, function, or variable intended for users to know about
516 \ / 516 \ /
517 @@end group 517 @@end group
518 @@end example 518 @@end example
519 @@end ifinfo 519 @@end ifinfo
520 520
521 If @@var@{n@} is a vector generate all combinations of the elements 521 If @@var@{n@} is a vector, this generates all combinations of the elements
522 of @@var@{n@}, taken @@var@{k@} at a time, one row per combination. The 522 of @@var@{n@}, taken @@var@{k@} at a time, one row per combination. The
523 resulting @@var@{c@} has size @@code@{[nchoosek (length (@@var@{n@}), 523 resulting @@var@{c@} has size @@code@{[nchoosek (length (@@var@{n@}),
524 @@var@{k@}), @@var@{k@}]@}. 524 @@var@{k@}), @@var@{k@}]@}.
525 525
526 @@seealso@{bincoeff@} 526 @@seealso@{bincoeff@}