Mercurial > hg > octave-lyh
changeset 11392:757efa1d7e2a
Remove deprecated functions from manual.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sat, 18 Dec 2010 14:37:11 -0800 |
| parents | 98d523608f70 |
| children | 7708bad09ad1 |
| files | doc/ChangeLog doc/interpreter/container.txi doc/interpreter/func.txi doc/interpreter/linalg.txi doc/interpreter/numbers.txi doc/interpreter/signal.txi doc/interpreter/sparse.txi doc/interpreter/stats.txi doc/interpreter/system.txi |
| diffstat | 9 files changed, 30 insertions(+), 45 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,10 @@ +2010-12-17 Rik <octave@nomad.inbox5.com> + + * interpreter/container.txi, interpreter/func.txi, + interpreter/linalg.txi, interpreter/numbers.txi, + interpreter/signal.txi, interpreter/sparse.txi, interpreter/stats.txi, + interpreter/system.txi: Remove deprecated functions from manual. + 2010-12-17 Rik <octave@nomad.inbox5.com> * interpreter/doccheck/mk_undocumented_list: Update script to
--- a/doc/interpreter/container.txi +++ b/doc/interpreter/container.txi @@ -829,8 +829,6 @@ @DOCSTRING(iscellstr) -@DOCSTRING(cellidx) - @node Processing Data in Cell Arrays @subsection Processing Data in Cell Arrays
--- a/doc/interpreter/func.txi +++ b/doc/interpreter/func.txi @@ -1206,61 +1206,58 @@ Commands are a special class of functions that only accept string input arguments. A command can be called as an ordinary function, but -it can also be called without the parentheses like the following example -shows +it can also be called without the parentheses. For example, @example my_command hello world @end example @noindent -which is the same as +is equivalent to @example my_command("hello", "world") @end example +@noindent The general form of a command call is @example -@var{name} @var{arg1} @var{arg2} @dots{} +@var{cmdname} @var{arg1} @var{arg2} @dots{} @end example @noindent which translates directly to @example -@var{name} ("@var{arg1}", "@var{arg2}", @dots{}) +@var{cmdname} ("@var{arg1}", "@var{arg2}", @dots{}) @end example -A function can be used as a command if it accepts string input arguments. -To do this, the function must be marked as a command, which can be done -with the @code{mark_as_command} command like this - +Any regular function can be used as a command if it accepts string input +arguments. For example: @example -mark_as_command name +@group +toupper lower_case_arg + @result{} ans = LOWER_CASE_ARG +@end group @end example -@noindent -where @code{name} is the function to be marked as a command. - One difficulty of commands occurs when one of the string input arguments -are stored in a variable. Since Octave can't tell the difference between -a variable name, and an ordinary string, it is not possible to pass a +is stored in a variable. Because Octave can't tell the difference between +a variable name and an ordinary string, it is not possible to pass a variable as input to a command. In such a situation a command must be -called as a function. - -@DOCSTRING(mark_as_command) +called as a function. For example: -@DOCSTRING(unmark_command) - -@DOCSTRING(iscommand) +@example +@group +strvar = "hello world"; +toupper strvar + @result{} ans = STRVAR +toupper (strvar) + @result{} ans = HELLO WORLD +@end group +@end example -@DOCSTRING(mark_as_rawcommand) - -@DOCSTRING(unmark_rawcommand) - -@DOCSTRING(israwcommand) @node Organization of Functions @section Organization of Functions Distributed with Octave
--- a/doc/interpreter/linalg.txi +++ b/doc/interpreter/linalg.txi @@ -88,8 +88,6 @@ @DOCSTRING(det) -@DOCSTRING(dmult) - @DOCSTRING(dot) @DOCSTRING(eig)
--- a/doc/interpreter/numbers.txi +++ b/doc/interpreter/numbers.txi @@ -537,8 +537,6 @@ @DOCSTRING(intmin) -@DOCSTRING(intwarning) - @menu * Integer Arithmetic:: @end menu
--- a/doc/interpreter/signal.txi +++ b/doc/interpreter/signal.txi @@ -82,10 +82,6 @@ @DOCSTRING(arma_rnd) -@DOCSTRING(autocor) - -@DOCSTRING(autocov) - @DOCSTRING(autoreg_matrix) @DOCSTRING(bartlett)
--- a/doc/interpreter/sparse.txi +++ b/doc/interpreter/sparse.txi @@ -219,17 +219,12 @@ creates a sparse (@var{n}+1)-by-(@var{n}+1) sparse matrix with a single diagonal defined. - @DOCSTRING(spdiags) @DOCSTRING(speye) @DOCSTRING(spfun) -@DOCSTRING(spmax) - -@DOCSTRING(spmin) - @DOCSTRING(spones) @DOCSTRING(sprand)