Mercurial > octave

changeset 32913:6fba256defcb stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Note inability to use 'end' within subsXX function docstrings (bug #59737) * libinterp/octave-value/ov.cc (subsref), (subsasgn): Add docstring note mentioning that the end keyword cannot be used in these functions. * scripts/miscellaneous/substruct.m: Add docstring note mentioning that the end keyword cannot be used in subsref and subsasgn functions.
author Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
date Fri, 02 Feb 2024 20:53:48 -0500
parents fd75534ea60e
children 399bdb5b3b48 a6263da53f6a
files libinterp/octave-value/ov.cc scripts/miscellaneous/substruct.m
diffstat 2 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/octave-value/ov.cc	Fri Feb 02 11:36:26 2024 -0800
+++ b/libinterp/octave-value/ov.cc	Fri Feb 02 20:53:48 2024 -0500
@@ -3704,6 +3704,9 @@
 
 If @var{idx} is an empty structure array with fields @samp{type} and
 @samp{subs}, return @var{val}.
+
+The keyword @code{end} cannot be used within @code{subsref} for indexing
+assignments.
 @seealso{subsasgn, substruct}
 @end deftypefn */)
 {
@@ -3753,6 +3756,9 @@
 
 If @var{idx} is an empty structure array with fields @samp{type} and
 @samp{subs}, return @var{rhs}.
+
+The keyword @code{end} cannot be used within @code{subsasgn} for indexing
+assignments.
 @seealso{subsref, substruct, optimize_subsasgn_calls}
 @end deftypefn */)
 {
--- a/scripts/miscellaneous/substruct.m	Fri Feb 02 11:36:26 2024 -0800
+++ b/scripts/miscellaneous/substruct.m	Fri Feb 02 20:53:48 2024 -0500
@@ -47,6 +47,9 @@
 ##   @result{}   7   8   9
 ## @end group
 ## @end example
+##
+## Note: The keyword @code{end} cannot be used within @code{subsref} or
+## @code{subsasgn} for indexing assignments.
 ## @seealso{subsref, subsasgn}
 ## @end deftypefn