diff libinterp/corefcn/pr-output.cc @ 31660:ccbf38427774 stable

doc: Note interaction between format and output_precision (bug #39832) * libinterp/corefcn/pr-flt-fmt.cc (output_precision), pr-output.cc (format): Add note to docstring indicating that format can change the set value of output_precision.
author Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
date Sat, 10 Dec 2022 07:19:18 -0500
parents aac27ad79be6
children 597f3ee61a48
line wrap: on
line diff
--- a/libinterp/corefcn/pr-output.cc	Fri Dec 09 12:21:14 2022 -0500
+++ b/libinterp/corefcn/pr-output.cc	Sat Dec 10 07:19:18 2022 -0500
@@ -3819,10 +3819,12 @@
 Reset or specify the format of the output produced by @code{disp} and Octave's
 normal echoing mechanism.
 
-This command only affects the display of numbers, but not how they are stored
+This command only affects the display of numbers, not how they are stored
 or computed.  To change the internal representation from the default double use
 one of the conversion functions such as @code{single}, @code{uint8},
-@code{int64}, etc.
+@code{int64}, etc.  Any @code{format} options that change the number of
+displayed significant digits will also be reflected by the
+@code{output_precision} function.
 
 By default, Octave displays 5 significant digits in a human readable form
 (option @samp{short}, option @samp{lowercase}, and option @samp{loose} format