# HG changeset patch
# User Rik <rik@octave.org>
# Date 1391551669 28800
# Node ID 812162c34a931de0bb7a894a42058182090ebbbe
# Parent  c71cbbae9443c8a62674bcae915fce4b14bcd534
Improve docstring for fixed_point_format().

* pr-output.cc (Ffixed_point_format): Improve docstring.

diff -r c71cbbae9443 -r 812162c34a93 libinterp/corefcn/pr-output.cc
--- a/libinterp/corefcn/pr-output.cc	Tue Feb 04 16:53:48 2014 -0500
+++ b/libinterp/corefcn/pr-output.cc	Tue Feb 04 14:07:49 2014 -0800
@@ -3979,13 +3979,15 @@
 @deftypefnx {Built-in Function} {@var{old_val} =} fixed_point_format (@var{new_val})\n\
 @deftypefnx {Built-in Function} {} fixed_point_format (@var{new_val}, \"local\")\n\
 Query or set the internal variable that controls whether Octave will\n\
-use a scaled format to print matrix values such that the largest\n\
-element may be written with a single leading digit with the scaling\n\
-factor is printed on the first line of output.  For example:\n\
+use a scaled format to print matrix values.\n\
+\n\
+The scaled format prints a scaling factor on the first line of output chosen\n\
+such that the largest matrix element can be written with a single leading\n\
+digit.  For example:\n\
 \n\
 @example\n\
 @group\n\
-octave:1> logspace (1, 7, 5)'\n\
+logspace (1, 7, 5)'\n\
 ans =\n\
 \n\
   1.0e+07  *\n\
@@ -3999,9 +4001,9 @@
 @end example\n\
 \n\
 @noindent\n\
-Notice that first value appears to be zero when it is actually 1.  For\n\
-this reason, you should be careful when setting\n\
-@code{fixed_point_format} to a nonzero value.\n\
+Notice that the first value appears to be 0 when it is actually 1.  Because\n\
+of the possibilty for confusion you should be careful about enabling\n\
+@code{fixed_point_format}.\n\
 \n\
 When called from inside a function with the @qcode{\"local\"} option, the\n\
 variable is changed locally for the function and any subroutines it calls.  \n\