[Octave-bug-tracker] [bug #63561] "unusable help text" error in chi2gof on installation

[Jim Van Zandt]

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

                 Summary: "unusable help text" error in chi2gof on
installation
                 Project: GNU Octave
               Submitter: vanzandtj
               Submitted: Thu 22 Dec 2022 06:58:34 PM UTC
                Category: None
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Installation Failure
                  Status: None
             Assigned to: None
         Originator Name: James R Van Zandt
        Originator Email: 
             Open/Closed: Open
                 Release: 7.3.0
         Discussion Lock: Any
        Operating System: Mac OS
           Fixed Release: None
         Planned Release: None


    _______________________________________________________

Follow-up Comments:


-------------------------------------------------------
Date: Thu 22 Dec 2022 06:58:34 PM UTC By: Jim Van Zandt <vanzandtj>
I have a Mac running macOS Big Sur (Version 11.7.2)

I have: 
$ octave
GNU Octave, version 7.3.0
Copyright (C) 1993-2022 The Octave Project Developers.
This is free software; see the source code for copying conditions.
There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  For details, type 'warranty'.


Octave was configured for "x86_64-apple-darwin20.6.0".


I installed the statistics package:

octave:2> pkg install -forge statistics
...
octave-help-8AC2XY:141: misplaced {
octave-help-8AC2XY:141: misplaced }
octave-help-8AC2XY:141: misplaced {
octave-help-8AC2XY:141: misplaced }
warning: doc_cache_create: unusable help text found in file 'chi2gof'
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 612 column 9
...


After installation, asking for help yields the same error message:

octave:8> which chi2gof
'chi2gof' is a function from the file
/Users/jrv/.local/share/octave/api-v57/packages/statistics-1.5.2/chi2gof.m
octave:9> help chi2gof
octave-help-DDTlVM:141: misplaced {
octave-help-DDTlVM:141: misplaced }
octave-help-DDTlVM:141: misplaced {
octave-help-DDTlVM:141: misplaced }
warning: help: Texinfo formatting filter exited abnormally; raw Texinfo source
of help text follows...
'chi2gof' is a function from the file
/Users/jrv/.local/share/octave/api-v57/packages/statistics-1.5.2/chi2gof.m

 -- Function File: H = chi2gof (X)
 -- Function File: [H, P] = chi2gof (X)
 -- Function File: [P, H, STATS] = chi2gof (X)
 -- Function File: [...] = chi2gof (X, NAME1, VALUE1, ...)

     Chi-square goodness-of-fit test.

     ‘chi2gof’ performs a chi-square goodness-of-fit test for discrete
     or continuous distributions.  The test is performed by grouping the
     data into bins, calculating the observed and expected counts for
...

chi2gof is installed here:
~/.local/share/octave/api-v57/packages/statistics-1.5.2/chi2gof.m

My binary search suggests the problem is in these lines:

## @tex $$ \chi ^ 2 = \sum_{i=1}^N \left (O_i - E_i \right) ^ 2 / E_i $$
## @end tex

That is syntactically correct tex.


This substitution will eliminate the error message:

## @tex @math{ \chi ^ 2 = \sum_{i=1}^N \left (O_i - E_i \right) ^ 2 / E_i }
## @end tex

but there may be a better solution.  

I'm using Octave in a terminal window that could not display a typeset
equation anyway.  The help text here includes:

     those bins, and computing the chi-square test statistic
     SUM((O-E).^2./E), where O is the observed counts and E is the
     expected counts.  This test statistic has an approximate







    _______________________________________________________

Reply to this item at:

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

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