changeset 32970:9fcb77b0341b stable

doc: Fix Texinfo problem in profile.m. * profile.m: Move @seealso macro *outside* of @table. Improve wording for "profile on" documentation.
author Rik <rik@octave.org>
date Wed, 07 Feb 2024 18:24:12 -0800
parents 360bb7c222c4
children 8994b39d7705 f1bf2e22a94f
files scripts/profiler/profile.m
diffstat 1 files changed, 3 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/profiler/profile.m	Wed Feb 07 14:51:46 2024 -0500
+++ b/scripts/profiler/profile.m	Wed Feb 07 18:24:12 2024 -0800
@@ -34,7 +34,7 @@
 ##
 ## @table @code
 ## @item profile on
-## Start the profiler, clearing all previously collected data if there is any.
+## Start the profiler.  Any previously collected data is cleared.
 ##
 ## @item profile off
 ## Stop profiling.  The collected data can later be retrieved and examined
@@ -61,8 +61,9 @@
 ## index into the @code{FunctionTable} identifying the function it corresponds
 ## to as well as data fields for number of calls and time spent at this level
 ## in the call tree.
+## @end table
+##
 ## @seealso{profshow, profexplore}
-## @end table
 ## @end deftypefn
 
 function retval = profile (arg)