changeset 13761:2d574194718c

namelengthmax.m: Consolidate docstring by using @math macro. Add %!test. * namelengthmax.m: Consolidate docstring by using @math macro. Add %!test.
author Rik <octave@nomad.inbox5.com>
date Thu, 27 Oct 2011 15:40:56 -0700
parents 1d97688f8522
children 649210ed43b4
files scripts/miscellaneous/namelengthmax.m
diffstat 1 files changed, 5 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/miscellaneous/namelengthmax.m	Thu Oct 27 09:50:03 2011 -0700
+++ b/scripts/miscellaneous/namelengthmax.m	Thu Oct 27 15:40:56 2011 -0700
@@ -19,14 +19,8 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} namelengthmax ()
 ## Return the @sc{matlab} compatible maximum variable name length.  Octave is
-## capable of storing strings up to
-## @tex
-## $2^{31} - 1$
-## @end tex
-## @ifnottex
-## @code{2 ^ 31 - 1}
-## @end ifnottex
-## in length.  However for @sc{matlab} compatibility all variable, function
+## capable of storing strings up to @math{2^{31} - 1} in length.
+## However for @sc{matlab} compatibility all variable, function,
 ## and structure field names should be shorter than the length supplied by
 ## @code{namelengthmax}.  In particular variables stored to a @sc{matlab} file
 ## format will have their names truncated to this length.
@@ -35,3 +29,6 @@
 function n = namelengthmax ()
   n = 63;
 endfunction
+
+
+%!assert (namelengthmax, 63)