changeset 17448:cc7815488981

__makeinfo__.m: Add documentation note to code about use of 3rd argument. * scripts/help/__makeinfo__.m: Add note that code for processing 3rd argument can not be deleted until generate_package_html function in Octave-Forge is updated.
author Rik <rik@octave.org>
date Mon, 16 Sep 2013 08:20:16 -0700
parents 8c22a8d42833
children aa380b380315
files scripts/help/__makeinfo__.m
diffstat 1 files changed, 3 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/help/__makeinfo__.m
+++ b/scripts/help/__makeinfo__.m
@@ -72,6 +72,9 @@
     error ("__makeinfo__: second input argument must be a string");
   endif
 
+  ## NOTE: The 3rd argument is used by Octave-Forge function
+  ##       generate_package_html, not by core Octave.  This functionality
+  ##       can only be removed when that function has been updated.
   if (nargin < 3)
     if (strcmpi (output_type, "plain text"))
       fsee_also = @(T) strcat ...