changeset 17151:f7fd413dcf4a

doc: Remove subnode on built-in variables which no longer exist. * doc/interpreter/intro.txi: Remove node on built-in variables which no longer exist. * doc/interpreter/octave.texi: Remove "A Sample Variable Description" node from the menu of nodes.
author Rik <rik@octave.org>
date Thu, 01 Aug 2013 17:47:36 -0700
parents 88616c872933
children bbda4d952eb5
files doc/interpreter/intro.txi doc/interpreter/octave.texi
diffstat 2 files changed, 3 insertions(+), 29 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/intro.txi
+++ b/doc/interpreter/intro.txi
@@ -532,15 +532,15 @@
 @subsection Format of Descriptions
 @cindex description format
 
-Functions, commands, and variables are described in this manual in a 
+Functions and commands are described in this manual in a 
 uniform format.  The first line of a description contains the name of
 the item followed by its arguments, if any.
 @ifnottex
-The category---function, variable, or whatever---appears at the
+The category---function, command, or whatever---appears at the
 beginning of the line.
 @end ifnottex
 @iftex
-The category---function, variable, or whatever---is printed next to the
+The category---function, command, or whatever---is printed next to the
 right margin.
 @end iftex
 The description follows on succeeding lines, sometimes with examples.
@@ -548,7 +548,6 @@
 @menu
 * A Sample Function Description::  
 * A Sample Command Description::  
-* A Sample Variable Description::  
 @end menu
 
 @node A Sample Function Description
@@ -643,27 +642,3 @@
 printed and the working directory is not changed.
 @end deftypefn
 
-@node A Sample Variable Description
-@subsubsection A Sample Variable Description
-@cindex variable descriptions
-
-A @dfn{variable} is a name that can hold a value.  Although any variable
-can be set by the user, @dfn{built-in variables} typically exist
-specifically so that users can change them to alter the way Octave
-behaves (built-in variables are also sometimes called @dfn{user
-options}).  Ordinary variables and built-in variables are described
-using a format like that for functions except that there are no
-arguments.
-
-Here is a description of the imaginary variable
-@code{do_what_i_mean_not_what_i_say}.
-
-@defvr {Built-in Variable} do_what_i_mean_not_what_i_say
-If the value of this variable is nonzero, Octave will do what you
-actually wanted, even if you have typed a completely different and
-meaningless list of commands.
-@end defvr
-
-Other variable descriptions have the same format, but `Built-in
-Variable' is replaced by `Variable', for ordinary variables, or
-`Constant' for symbolic constants whose values cannot be changed.
--- a/doc/interpreter/octave.texi
+++ b/doc/interpreter/octave.texi
@@ -222,7 +222,6 @@
 
 * A Sample Function Description::  
 * A Sample Command Description::  
-* A Sample Variable Description::  
 
 Getting Started