[Octave-bug-tracker] [bug #62075] io package has incorrect use of Texinfo @seealso macro

[Rik]

URL:
  <https://savannah.gnu.org/bugs/?62075>

                 Summary: io package has incorrect use of Texinfo @seealso
macro
                 Project: GNU Octave
            Submitted by: rik5
            Submitted on: Thu 17 Feb 2022 01:41:10 PM PST
                Category: Octave Forge Package
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: Confirmed
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
                 Release: other
         Discussion Lock: Any
        Operating System: Any

    _______________________________________________________

Details:

I just installed io-2.6.4 package from Octave Forge with a development version
of Octave.  I got many errors from doc_cache_create.  Here is one example:


/tmp/octave-help-T9lvr0:264: unknown command `seealso'
/tmp/octave-help-T9lvr0:264: misplaced {
/tmp/octave-help-T9lvr0:265: misplaced }
/tmp/octave-help-T9lvr0:264: unknown command `seealso'
/tmp/octave-help-T9lvr0:264: misplaced {
/tmp/octave-help-T9lvr0:265: misplaced }
warning: doc_cache_create: unusable help text found in file 'xlswrite'
warning: called from
    doc_cache_create>handle_function at line 98 column 5
    doc_cache_create>create_cache at line 118 column 36
    gen_doc_cache_in_dir>@<anonymous> at line 150 column 16
    doc_cache_create>gen_doc_cache_in_dir at line 151 column 9
    doc_cache_create at line 62 column 12
    install>generate_lookfor_cache at line 840 column 5
    install at line 241 column 7
    pkg at line 603 column 9


The fix is a simple one.  The m-file, and other Texinfo source cod in the io
package, use a space between the macro name "@seealso" and the opening curly
brace '{'.  For example,


@seealso {xlsread, xlsopen,


The fix is simply to remove the space and write


@seealso{xlsread, xlsopen,






    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?62075>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/