Bug Fix #12431 - Updated %helps help page
[scilab.git] / scilab / CHANGES.md
index 9a807ac..9786f4f 100644 (file)
@@ -13,7 +13,7 @@ This file is intended for the specific needs of advanced users, and describes:
 - Bug fixes.
 
 This changelog is most likely incomplete, as an enormous amount of code has changed between 5.5.2 and 6.
-Please report any thing we could have missed, on the [mailing lists][1] or on the [bug tracker][2], 
+Please report any thing we could have missed, on the [mailing lists][1] or on the [bug tracker][2],
 and we will correct it before the final Scilab 6.0.0 release.
 
 [1]: http://mailinglists.scilab.org
@@ -23,8 +23,8 @@ and we will correct it before the final Scilab 6.0.0 release.
 Main new features
 -----------------
 
-For high-level description of the main new features of this release, please 
-consult the [embedded help](modules/helptools/data/pages/homepage-en_US.html). It is also available 
+For high-level description of the main new features of this release, please
+consult the [embedded help](modules/helptools/data/pages/homepage-en_US.html). It is also available
 as the "What's new" page of the help, by simply typing `help` in Scilab console.
 
 In summary, the main new features are:
@@ -100,7 +100,7 @@ Language changes
 
 Some small changes have been done to the language syntax, aiming at more clarity and less
 ambiguity. Some changes are not compatible with 5.5; code written for Scilab 5.x
-has to be modified in order to work in Scilab 6.0. 
+has to be modified in order to work in Scilab 6.0.
 
 See [the wiki page on porting code from 5.5 to 6.0](https://wiki.scilab.org/FromScilab5ToScilab6)
 for details and examples.
@@ -111,10 +111,10 @@ for details and examples.
 * Declaring strings using non-homogenous delimiters ("string' or 'string") is no longer allowed.
 * `(a=b)` executed as `a == b` is now deprecated and returns an error.
 * Function definitions can finish with `end` instead of `endfunction`.
-* `{}` and `[]` are now distinct operators. Matrices can no longer be defined usind `{}` operators. 
+* `{}` and `[]` are now distinct operators. Matrices can no longer be defined usind `{}` operators.
 These are reserved for cell definition.
 * Shortcut and element-wise boolean operators are now distinct. `&&` and `||` are new shortcut boolean AND and OR,
-while `&` and `|` are element-wise operations and will not shortcut one of the operand. 
+while `&` and `|` are element-wise operations and will not shortcut one of the operand.
 Both shortcut and element-wise operators are evaluated from left to right.
 * Syntax `%i:10` is now deprecated (only real scalars can be used).
 * `while ... else ... end` control instruction is not supported anymore.
@@ -150,12 +150,12 @@ Feature changes and additions
 * `sign` can now handle a sparse matrix.
 * `sleep(..,'s')` allows now to specify the duration in seconds.
 * `real`, `imag`, `conj` and `isreal` now accept rational fractions.
-* A call stack limit has been introduced. Default maximum depth is setup to 1000 
+* A call stack limit has been introduced. Default maximum depth is setup to 1000
 and can be changed by `recursionlimit` or through the Preferences interface.
-* The floating point exception mode `ieee` is now set to `2` by default: floating 
+* The floating point exception mode `ieee` is now set to `2` by default: floating
 point exceptions now produce `Inf` or `Nan`, and do not cause any error.
 The previous behavior can be recalled by simply calling: `ieee(0)`.
-* The graphics entity "Datatip" has its property `z_component = 'on|off'` changed to 
+* The graphics entity "Datatip" has its property `z_component = 'on|off'` changed to
 `display_components = 'xyz'`; it is now possible to choose which components to display,
 and in which order. Loading old `*.scg` files containing datatips with "z_component"
 property may not display the z component.
@@ -163,7 +163,7 @@ property may not display the z component.
 * `amell` now:
   - checks if its parameters are real numbers,
   - throws an error if the second parameter is not a scalar.
-* The use of I/O console is now allowed with the following functions: `mget`, 
+* The use of I/O console is now allowed with the following functions: `mget`,
 `mgetl`, `mgetstr`, `mput`, `mputl` and `mputstr`.
 * `mclearerr` now returns a flag indicating the file identifier validity.
 * `fileinfo` can now take a row vector as input.
@@ -192,9 +192,9 @@ input and output arguments.
    - `bitxor` is now vectorized and fast.
 * The zoom rubber box now can start/finish from points lying outside the axes bounds.
 * The zoom rubber box now can select multiple and overlying axes at once. Changed behavior of scroll zoom,
-scrolling over overlying axes will zoom all of them together, using the CTRL key while scrolling 
+scrolling over overlying axes will zoom all of them together, using the CTRL key while scrolling
 will zoom all axes in the current figure.
-* The graphics entity "Datatip" has a new property `detached_position` which accepts `[]` 
+* The graphics entity "Datatip" has a new property `detached_position` which accepts `[]`
 or a 3-components vector to set the position in axes coordinates to draw the datatip text box.
 * `MPI_Create_comm` create a new communicator from MPI_COMM_WORLD using MPI world ranks.
 
@@ -202,7 +202,7 @@ Help pages:
 -----------
 
 * fixed / improved:  `members`, `part`, `ode`, `ode_optional_output`, `ode_roots`, `roots`,
-  `printf`, `sprintf`, `iconvert`, `stdev`, `xlabel`, `and_op`, `or_op`
+  `printf`, `sprintf`, `iconvert`, `stdev`, `xlabel`, `and_op`, `or_op`, `%helps`
 * rewritten: `consolebox`, `double`, `isoview`, `householder`, `or`, `and`, `format`, `typeof`,
 `brackets`, `setlanguage`, `sleep`, `isinf`, `bitor`, `bitxor`, `bitand`
 * reorganized:
@@ -235,9 +235,9 @@ Xcos
 
 * Major rewrite of the data structures, huge models should load and save faster.
 The memory usage on diagram edition is also slightly reduced.
-* ZCOS and XCOS file formats have evolved to reduce the duplicated information. 
+* ZCOS and XCOS file formats have evolved to reduce the duplicated information.
 Scilab 5.5.2 is able to open the newly saved files, but the ports have to be repositioned manually.
-* Implicit fixed-size step ODE solver added: Crank-Nicolson 2(3). 
+* Implicit fixed-size step ODE solver added: Crank-Nicolson 2(3).
 Added to the CVode package, it also benefits from the CVode rootfinding feature.
 * Block modifications :
   - `INVBLK`: add a divide by zero parameter to ignore the error
@@ -247,13 +247,13 @@ Added to the CVode package, it also benefits from the CVode rootfinding feature.
 API modification
 ----------------
 
-A new set of C APIs to write C or C++ extensions (toolboxes) to Scilab. 
+A new set of C APIs to write C or C++ extensions (toolboxes) to Scilab.
 It allows defining native functions (commonly called "gateways"), getting input parameters
 for such functions, setting return parameters, accessing local variables, using common helper
-functions for accessing environment information (such as warning level), generate errors... 
+functions for accessing environment information (such as warning level), generate errors...
 
 It also includes ways to overload existing Scilab functions to support additional parameter
-types (see `help scilab_overload`). Finally, you can call back Scilab functions 
+types (see `help scilab_overload`). Finally, you can call back Scilab functions
 (macros and built-in functions) from your gateway (see `help scilab_call`).
 
 User-defined functions written in C or C++ (gateways) must now use a `void* pvApiCtx` name
@@ -302,7 +302,7 @@ Known issues
 
 * Scilab 6 is still in a beta stage and likely to contain a number of known or unknown bugs.
 Do not hesitate to [report](https://bugzilla.scilab.org) them.
-* Toolboxes rebuild is in progress. Do not hesitate to submit patch or feature upgrade to 
+* Toolboxes rebuild is in progress. Do not hesitate to submit patch or feature upgrade to
 the [development mailing list](dev@lists.scilab.org) for a particular toolbox.
 
 
@@ -328,6 +328,7 @@ Bug Fixes
 * [#11692](http://bugzilla.scilab.org/show_bug.cgi?id=11692): The summary of a help section built from both default en_US and localized files was never sorted overall.
 * [#11959](http://bugzilla.scilab.org/show_bug.cgi?id=11959): Allow "Zoom Area" to be clicked out of axes
 * [#12110](http://bugzilla.scilab.org/show_bug.cgi?id=12110): Unable to zoom multiple axes at once
+* [#12431](http://bugzilla.scilab.org/show_bug.cgi?id=12431): The page describing the `%helps` variable needed clarification.
 * [#13166](http://bugzilla.scilab.org/show_bug.cgi?id=13166): `l` and `b` endian flags used with `mget` and `mgeti` were sticky
 * [#13375](http://bugzilla.scilab.org/show_bug.cgi?id=13375): If (Max - Min) == 1, then the multiple selection is not allowed.
 * [#13583](http://bugzilla.scilab.org/show_bug.cgi?id=13583): `getd` loading a script including a `clear` instruction yielded an error