changeset 32517:38318e51f27f stable

maint: Changes to wording of GUI strings and NEWS for clarity. * NEWS.9.md, welcome-wizard.cc: Changes to wording for clarity and consistency suggested by robertf on Discourse.
author Rik <rik@octave.org>
date Tue, 28 Nov 2023 22:02:33 -0800
parents f4b78192708f
children f511a54000f7 6ff63f154144
files etc/NEWS.9.md libgui/src/welcome-wizard.cc
diffstat 2 files changed, 92 insertions(+), 91 deletions(-) [+]
line wrap: on
line diff
--- a/etc/NEWS.9.md	Tue Nov 28 08:53:07 2023 -0800
+++ b/etc/NEWS.9.md	Tue Nov 28 22:02:33 2023 -0800
@@ -4,144 +4,145 @@
 ### General improvements
 
 - Octave now has an experimental bytecode interpreter for m-code.  Speedups
-from 2X to 40X have been observed for different kinds of m-code.  This feature
-is considered experimental for now.  M-code that cannot yet be handled by the
-bytecode interpreter falls back automatically to the existing tree-walker
-interpreter.  User tests of the bytecode interpreter are encouraged.  To learn
-more, type `bytecode` or `help bytecode` at the Octave prompt.
+  from 2X to 40X have been observed for different kinds of m-code.  This
+  feature is considered experimental for now.  M-code that cannot yet be
+  handled by the bytecode interpreter falls back automatically to the existing
+  tree-walker interpreter.  User tests of the bytecode interpreter are
+  encouraged.  To learn more, type `bytecode` or `help bytecode` at the Octave
+  prompt.
 
 - `oruntests`: The current directory now changes to the directory
-containing the files with the tests for the duration of the test.  This
-aligns the behavior of this function with Octave's test suite.  This also
-means that the file encoding specified in the `.oct-config` file for the
-respective directory is taken into account for the tests.
+  containing the files with the tests for the duration of the test.  This
+  aligns the behavior of this function with Octave's test suite.  This also
+  means that the file encoding specified in the `.oct-config` file for the
+  respective directory is taken into account for the tests.
 
 - `dec2base`, `dec2bin`, and `dec2hex` have all been overhauled.  All three
-functions now accommodate negative inputs and fractional inputs, and repeated
-code between the functions has been reduced or eliminated.  Previously only
-`dec2bin` and `dec2hex` accepted negative inputs but `dec2base` did not, and
-none of the three accepted fractional inputs.  But now,
-`dec2base (100*pi, 16, 4, 6)` for exampele returns a base-16 string with four
-places for the integer part and six places for the fractional part.  Omitting
-the number of decimal places (the fourth input) retains old behavior for
-backward compatibility, except that non-integer inputs will no longer error.
+  functions now accommodate negative inputs and fractional inputs, and repeated
+  code between the functions has been reduced or eliminated.  Previously only
+  `dec2bin` and `dec2hex` accepted negative inputs but `dec2base` did not, and
+  none of the three accepted fractional inputs.  But now, `dec2base (100*pi,
+  16, 4, 6)`, for example, returns a base-16 string with four places for the
+  integer part and six places for the fractional part.  Omitting the number of
+  decimal places (the fourth input) retains old behavior for backward
+  compatibility, except that non-integer inputs will no longer produce
+  errors.
 
 - `quiver` and `quiver3` now properly plot non-float numeric inputs by
-internally recasting them to 'double' (bug #59695).  Both functions now
-honor a previously ignored scaling factor input when there is only a
-single arrow (bug #39552), and `quiver3` no longer produces an error when a
-scaling factor is input without x and y inputs. Both functions now also
-accept a scale factor of "off" which is equivalent to setting it to 0.
-When a linestyle with a base marker is set suppressing arrowhead display,
-subsequent name-value property pairs in the quiver/quiver3 function call
-will no longer turn arrowhead display back on (bug #64143).  The linewdith
-property now also affect the line width of the base marker.
+  internally recasting them to 'double' (bug #59695).  Both functions now honor
+  a previously ignored scaling factor input when there is only a single arrow
+  (bug #39552), and `quiver3` no longer produces an error when a scaling factor
+  is input without x and y inputs. Both functions now also accept a scale
+  factor of "off" which is equivalent to setting it to 0.  When a linestyle
+  with a base marker is set suppressing arrowhead display, subsequent
+  name-value property pairs in the quiver/quiver3 function call will no longer
+  turn arrowhead display back on (bug #64143).  The linewdith property now also
+  affects the line width of the base marker.
 
 - Classdefs now support breakpoints inside them.
 
 - The `inputParser` function has been re-architected for a 60% performance
-improvement.
+  improvement.
 
 - The `perms` function has been made faster.
 
-- The `audiowrite` function now supports writing to MPEG audio formats --
-including MP3 -- if the `sndfile` library supports it.
+- The `audiowrite` function now supports writing to MPEG audio
+  formats---including MP3---if the `sndfile` library supports it.
 
 ### Graphical User Interface
 
 ### Graphics backend
 
 * The FLTK backend is not maintained and its use is discouraged.  The
-recommended backend is qt.  Enabling the fltk backend with
-`graphics_toolkit fltk` now emits a warning.
+  recommended backend is qt.  Enabling the fltk backend with `graphics_toolkit
+  fltk` now emits a warning.
 
-* The `set` function now accepts any combination of name/value pairs,
-cell array of names / cell array of values, or property structures.
-This change is Matlab-compatible.
+* The `set` function now accepts any combination of name/value pairs, cell
+  array of names / cell array of values, or property structures.  This change
+  is Matlab compatible.
 
 * When the `hold` function is used without arguments to toggle the current
-state the resulting value is now displayed in the Command Window for
-informational purposes.
+  state, the resulting value is now displayed in the Command Window for
+  informational purposes.
 
-* The axes graphics property "TickDir" now accepts the option "none" which
-will not draw tick marks, but will still draw tick labels.
+* The axes graphics property "TickDir" now accepts the option "none", which
+  will not draw tick marks but will still draw tick labels.
 
 ### Matlab compatibility
 
-- The `inputParser` function now implements the `PartialMatching` property
-for `Parameter` and `Switch` names.  For Matlab compatibility,
-`PartialMatching` is now set to true by default which may change the behavior
-of existing code.
+- The `inputParser` function now implements the `PartialMatching` property for
+  `Parameter` and `Switch` names.  For Matlab compatibility, `PartialMatching`
+  is now set to true by default which may change the behavior of existing code.
 
 - Overhauled `mean`, `median`, `var`, and `std` functions have been imported
-from statistics package v1.5.4 to compatibly implement 'nanflag' (bug #50571),
-'all' (bug #58116), and 'vecdim' (bug #58089) options, preserve output class,
-and match expected output behavior for empty (bug #50583) and sparse inputs
-(bug #63291).  Both `median` and `mean` can handle large int values without
-overflow or precision concerns (bug #54567), and `mean` avoids errors due to
-limits of single precision by processing as doubles (bug #63848).  `median`
-has also adopted the 'outtype' option from `mean`.
+  from statistics package v1.5.4 to compatibly implement 'nanflag' (bug
+  #50571), 'all' (bug #58116), and 'vecdim' (bug #58089) options, preserve
+  output class, and match expected output behavior for empty (bug #50583) and
+  sparse inputs (bug #63291).  Both `median` and `mean` can handle large int
+  values without overflow or precision concerns (bug #54567), and `mean` avoids
+  errors due to limits of single precision by processing as doubles (bug
+  #63848).  `median` has also adopted the 'outtype' option from `mean`.
 
-- Code such as `A = ones (3, 3); A(:, :, 1) = []` is now Matlab-compatible.
+- Code such as `A = ones (3, 3); A(:, :, 1) = []` is now Matlab compatible.
 
 - `mad` function now produces Matlab compatible output using improved `mean`
-and `median` functions.  'vecdim' and 'all' options are now supported.  `mad`
-ignores all NaN values (using 'omitnan' mean/median option) and produces
-expected output behavior for empty inputs.
+  and `median` functions.  'vecdim' and 'all' options are now supported.  `mad`
+  ignores all NaN values (using 'omitnan' mean/median option) and produces
+  expected output behavior for empty inputs.
 
 - `mode` now produces Matlab compatible output for empty inputs (bug #50583).
 
-- `linspace` and `logspace` now handle `inf` inputs in a Matlab-compatible way.
+- `linspace` and `logspace` now handle `inf` inputs in a Matlab compatible way.
 
 - `normalize` now produces Matlab compatible output for inputs containing NaN
-values (bug #50571).
+  values (bug #50571).
 
-- `cov` now processes the input form cov(x,y) with two separate data arrays
-x and y, as cov(x(:),y(:)) to maintain Matlab compatibility.  It also accepts
-a NANFLAG option to allow ignoring NaN entries in input data (bug #50571)
-and produces Matlab compatible outputs for empty inputs (bug #50583).  `corr`
-and `corrcoef` internal code has been adapted to the new `cov` behavior with
-no change to user interface.  Packages using the octave core's `cov` that rely
-on the previous calling form may need to make similar adaptations.  Calls for
-cov(x) with a vector x expecting a scalar return can get the previous results
-from `cov(x)(2)`, and calls to cov(x,y) with x and y matrices expecting
-columnwise covariance calculation can obtain the previous results using
-`cov([x,y])(1:nx, nx+1:end)`, where nx = columns(x).
+- `cov` now processes the input form cov(x,y) with two separate data arrays x
+  and y, as cov(x(:),y(:)) to maintain Matlab compatibility.  It also accepts a
+  NANFLAG option to allow ignoring NaN entries in input data (bug #50571) and
+  produces Matlab compatible outputs for empty inputs (bug #50583).  `corr` and
+  `corrcoef` internal code has been adapted to the new `cov` behavior with no
+  change to user interface.  Packages using the octave core's `cov` that rely
+  on the previous calling form may need to make similar adaptations.  Calls for
+  cov(x) with a vector x expecting a scalar return can get the previous results
+  from `cov(x)(2)`, and calls to cov(x,y) with x and y matrices expecting
+  columnwise covariance calculation can obtain the previous results using
+  `cov([x,y])(1:nx, nx+1:end)`, where nx = columns(x).
 
-- `qz` now handles input and output arguments in a Matlab compatible
-way. It always computes the complex QZ decomposition if there are only
-two input arguments, and it accepts an optional third input argument
-'real' or 'complex' to select the type of decomposition. The output
-arguments are always in the same order independently of the input
-arguments, and the generalized eigenvalues are no longer returned (one
-can use the `ordeig` function for that purpose). The optional reordering
-of the generalized eigenvalues has been removed (one can use the `ordqz`
-function for that purpose).
+- `qz` now handles input and output arguments in a Matlab compatible way. It
+  always computes the complex QZ decomposition if there are only two input
+  arguments, and it accepts an optional third input argument 'real' or
+  'complex' to select the type of decomposition. The output arguments are
+  always in the same order independently of the input arguments, and the
+  generalized eigenvalues are no longer returned (one can use the `ordeig`
+  function for that purpose). The optional reordering of the generalized
+  eigenvalues has been removed (one can use the `ordqz`
+  function for that purpose).
 
 - `pcolor` now sets the axes limits to be just large enough to display the
-plotted data (equivalent of `axis tight`).
+  plotted data (equivalent of `axis tight`).
 
 - `xlim`, `ylim`, `zlim` functions can now query or set the limit calculation
-method which is one of "tickaligned", "tight", or "padded".
+  method which is one of "tickaligned", "tight", or "padded".
 
-- `optimget` and `optimset` now error on an ambiguous match of an incomplete
-option name instead of emitting a warning.
+- `optimget` and `optimset` now produce an error on an ambiguous match of an
+  incomplete option name instead of emitting a warning.
 
-- `datevec` when provided a date format will match date string characters
-up to the length of the format string.  A date vector will be returned as
-long the characters up to the format string length is a perfect match, and
-any trailing characters in the date string wil be ignored. (bug #42241)
+- `datevec` when provided a date format will match date string characters up to
+  the length of the format string.  A date vector will be returned as long as
+  the characters up to the format string length are a perfect match, and any
+  trailing characters in the date string will be ignored. (bug #42241)
 
-- `unwrap` now produces compatible output for inputs with non-finite
-elements (Inf, NaN, NA).  Such elements will now retained in the output but
-skipped over by the wrapping calculation.  The function also permits
-logical inputs and specified operating dimensions larger than the number
-of dimensions in the input array.
+- `unwrap` now produces compatible output for inputs with non-finite elements
+  (Inf, NaN, NA).  Such elements will now retained in the output but skipped
+  over by the wrapping calculation.  The function also permits logical inputs
+  and specified operating dimensions larger than the number of dimensions in
+  the input array.
 
 - The default string length for the function `rats` has changed from 9 to 13.
 
 - *Continuing reminder of future breaking changes*:  There is ongoing work
-  to implement a Matlab-compatible string class that will differ from a vector
+  to implement a Matlab compatible string class that will differ from a vector
   of characters.  In Octave, single-quoted character arrays are currently
   compatible with Matlab, but double-quoted forms are not, and are likely to
   change in future as a consequence of implementing Matlab-style string syntax.
--- a/libgui/src/welcome-wizard.cc	Tue Nov 28 08:53:07 2023 -0800
+++ b/libgui/src/welcome-wizard.cc	Tue Nov 28 22:02:33 2023 -0800
@@ -257,7 +257,7 @@
   m_checkbox_message->setText
     (tr ("<html><head>\n"
          "</head><body>\n"
-         "<p>Allow Octave to connect to the Octave web site when it starts to display current news and information about the Octave community.</p>\n"
+         "<p>Allow Octave to connect to the Octave web site when it starts in order to display current news and information about the Octave community.</p>\n"
          "</body></html>"));
   m_checkbox_message->setWordWrap (true);
   m_checkbox_message->setOpenExternalLinks (true);
@@ -343,7 +343,7 @@
          "<p>For more information about Octave:</p>\n"
          "<ul>\n"
          "<li>Visit <a href=\"https://octave.org\">https://octave.org</a> (opens in external browser)</li>\n"
-         "<li>Get the documentation online as <a href=\"https://www.gnu.org/software/octave/doc/interpreter/index.html\">html</a>- or <a href=\"https://www.gnu.org/software/octave/octave.pdf\">pdf</a>-document (opens in external browser)</li>\n"
+         "<li>Get the documentation online in <a href=\"https://www.gnu.org/software/octave/doc/interpreter/index.html\">HTML</a> or <a href=\"https://www.gnu.org/software/octave/octave.pdf\">PDF</a> format (links open in external browser)</li>\n"
          "<li>Open the documentation browser of the Octave GUI with the help menu</li>\n"
          "</ul>\n"
          "</body></html>"));