bugGNU Octave - Bugs: bug #51998, Poor explanation of some items in...

 
 

bug #51998: Poor explanation of some items in warning_ids()

Submitted by:  Ernst Reissner <ernstreissner>
Submitted on:  Tue 12 Sep 2017 09:41:46 AM UTC  
 
Category: DocumentationSeverity: 3 - Normal
Priority: 5 - NormalItem Group: Documentation
Status: ConfirmedAssigned to: None
Originator Name: ernstreissnerOpen/Closed: Open
Release: devOperating System: Any

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

(Jump to the original submission Jump to the original submission)

Wed 13 Sep 2017 10:10:04 PM UTC, comment #6:

I think, warning_ids contains what is in the manual.
Well, sometimes it does not help.

@Kai:
your idea with grep is fine.
I tried:

find . -type f -and
! -name "*.texi" -and
! -name "*.dvi" -and
! -name "*.html" -and
! -name "*.ps" -and
! -name "*.txi"
-exec grep "Octave:load-file-in-path" {} \; -print

Result:

Octave:load-file-in-path
Octave:nested-functions-coerced
in docs only

Octave:logical-conversion
./libinterp/corefcn/errwarn.cc
./libinterp/corefcn/gripes.cc

Octave:recursive-path-search
./libinterp/corefcn/load-path.cc

Octave:nearly-singular-matrix
./liboctave/util/lo-array-gripes.cc
./liboctave/util/lo-array-errwarn.cc

Octave:sqrtm:SingularMatrix
./libinterp/corefcn/sqrtm.cc

Also for the other warnings, understood but not documented.
Octave:noninteger-range-as-index
./libinterp/octave-value/ov-range.cc

Octave:shadowed-function
./libinterp/corefcn/load-path.cc

Octave:singular-matrix
./liboctave/util/lo-array-gripes.cc
./liboctave/util/lo-array-errwarn.cc

Ernst Reissner <ernstreissner>
Wed 13 Sep 2017 01:01:09 PM UTC, comment #5:

@Ernst: if the output of `warning_ids` does not help, you can take a look at where those IDs are used. For example `grep` in the octave development sources for them:

Maybe then you can suggest a short explanation of the IDs that we can fit in `warning_ids`.

Kai Torben Ohlhus <siko1056>
Project Member
Tue 12 Sep 2017 09:40:09 PM UTC, comment #4:

I can help, but it may take a while as I'm busy with something else at the moment.

John W. Eaton <jwe>
Project Administrator
Tue 12 Sep 2017 08:49:09 PM UTC, comment #3:

Yes, Philip is right:
difficult to improve what i did not understand.
In some cases, there is no explanation at all
and i cannot figure out the details.
What we need is analysis of the code if nothing else helps.

Ernst Reissner <ernstreissner>
Tue 12 Sep 2017 08:18:21 PM UTC, comment #2:

AFAIU Ernst says he doesn't know the meaning of the warnings in the first place, so how could he come up with better wording?

Philip Nienhuis <philipnienhuis>
Project Member
Tue 12 Sep 2017 01:53:49 PM UTC, comment #1:

Ernst,

Thank you. Could you suggest what each of them should be please? If we can use your language in the documentation that would be even more useful to users.

Anonymous
Tue 12 Sep 2017 09:41:46 AM UTC, original submission:

I do not understand the explanation
of following warnings... maybe should be more explicit.
Octave:load-file-in-path
Octave:logical-conversion
Octave:nested-functions-coerced
Octave:recursive-path-search
Octave:nearly-singular-matrix what means nearly???
Octave:sqrtm:SingularMatrix

The following i understand but still an explanation is missing:
Octave:noninteger-range-as-index
Octave:shadowed-function
Octave:singular-matrix

Ernst Reissner <ernstreissner>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by siko1056 (Posted a comment)
  • -unavailable- added by jwe (Posted a comment)
  • -unavailable- added by ernstreissner (Submitted the item)
  • -unavailable- added by ernstreissner
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 3 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Wed 13 Sep 2017 01:02:09 PM UTCsiko1056StatusNone=>Confirmed
      Summaryexplanation of warnings =>Poor explanation of some items in warning_ids()
    Tue 12 Sep 2017 09:41:46 AM UTCernstreissnerCarbon-Copy-=>Added -unavailable-

    Back to the top


    Powered by Savane 3.1-cleanup1