Mercurial > octave

changeset 32581:ca5d00ab014c stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Apply consistent notes in docstrings for aliased functions * /libinterp/corefcn/data.cc (islogical, merge): Add Programming Note about isbool and ifelse aliases. * /libinterp/corefcn/debug.cc (dbstep): Update Programming Note about dbnext alias. * libinterp/corefcn/interpreter.cc (quit): Add deftypefnx definition and update Programming Note about exit alias. * libinterp/corefcn/inv.cc: Update Programming Note about inverse alias. * libinterp/corefcn/sysdep.cc (clc): Add Programming Note about home alias.
author Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
date Mon, 11 Dec 2023 18:28:46 -0500
parents 3f744873ad4d
children 9c5b8e82bbae 05b4479c29d8
files libinterp/corefcn/data.cc libinterp/corefcn/debug.cc libinterp/corefcn/interpreter.cc libinterp/corefcn/inv.cc libinterp/corefcn/sysdep.cc
diffstat 5 files changed, 17 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/data.cc	Sun Dec 10 11:30:47 2023 -0800
+++ b/libinterp/corefcn/data.cc	Mon Dec 11 18:28:46 2023 -0500
@@ -3329,6 +3329,9 @@
 @deftypefn  {} {@var{tf} =} islogical (@var{x})
 @deftypefnx {} {@var{tf} =} isbool (@var{x})
 Return true if @var{x} is a logical object.
+
+Programming Note: @code{isbool} is an alias for @code{islogical} and can be
+used interchangeably.
 @seealso{ischar, isfloat, isinteger, isstring, isnumeric, isa}
 @end deftypefn */)
 {
@@ -8028,6 +8031,9 @@
 
 @var{mask} can also be arbitrary numeric type, in which case it is first
 converted to logical.
+
+Programming Note: @code{ifelse} is an alias for @code{merge} and can be used
+interchangeably.
 @seealso{logical, diff}
 @end deftypefn */)
 {
--- a/libinterp/corefcn/debug.cc	Sun Dec 10 11:30:47 2023 -0800
+++ b/libinterp/corefcn/debug.cc	Mon Dec 11 18:28:46 2023 -0500
@@ -1089,7 +1089,8 @@
 Using @code{dbstep out} will cause execution to continue until the current
 function returns.
 
-@code{dbnext} is an alias for @code{dbstep}.
+Programming Note: @code{dbnext} is an alias for @code{dbstep} and can be used
+interchangeably.
 @seealso{dbcont, dbquit}
 @end deftypefn */)
 {
--- a/libinterp/corefcn/interpreter.cc	Sun Dec 10 11:30:47 2023 -0800
+++ b/libinterp/corefcn/interpreter.cc	Mon Dec 11 18:28:46 2023 -0500
@@ -149,10 +149,9 @@
 @deftypefnx {} {} quit ("force")
 @deftypefnx {} {} quit (@var{status})
 @deftypefnx {} {} quit (@var{status}, "force")
+@deftypefnx {} {} exit (@dots{})
 Quit the current Octave session.
 
-The @code{exit} function is an alias for @code{quit}.
-
 If the optional integer value @var{status} is supplied, pass that value to
 the operating system as Octave's exit status.  The default value is zero.
 
@@ -173,6 +172,9 @@
 
 If the optional argument @qcode{"force"} is provided, no confirmation is
 requested, and the execution of the @file{finish.m} file is skipped.
+
+Programming Note: @code{exit} is an alias for @code{quit} and can be used
+interchangeably.
 @seealso{atexit}
 @end deftypefn */)
 {
--- a/libinterp/corefcn/inv.cc	Sun Dec 10 11:30:47 2023 -0800
+++ b/libinterp/corefcn/inv.cc	Mon Dec 11 18:28:46 2023 -0500
@@ -61,7 +61,8 @@
 matrix requiring significantly more storage.  Avoid forming the inverse of a
 sparse matrix if possible.
 
-@code{inverse} is an alias and may be used identically in place of @code{inv}.
+Programming Note: @code{inverse} is an alias for @code{inv} and can be used
+interchangeably.
 @seealso{ldivide, rdivide, pinv}
 @end deftypefn */)
 {
--- a/libinterp/corefcn/sysdep.cc	Sun Dec 10 11:30:47 2023 -0800
+++ b/libinterp/corefcn/sysdep.cc	Mon Dec 11 18:28:46 2023 -0500
@@ -731,6 +731,9 @@
 @deftypefn  {} {} clc ()
 @deftypefnx {} {} home ()
 Clear the terminal screen and move the cursor to the upper left corner.
+
+Programming Note: @code{home} is an alias for @code{clc} and can be used
+interchangeably.
 @end deftypefn */)
 {
   bool skip_redisplay = true;