bugGNU Octave - Bugs: bug #39939, Private functions should not...

 
 

bug #39939: Private functions should not appear in the documentation

Submitted by:  Rafael Laboissiere <rlaboiss>
Submitted on:  Wed 04 Sep 2013 09:58:07 AM UTC  
 
Category: DocumentationSeverity: 3 - Normal
Priority: 5 - NormalItem Group: Documentation
Status: FixedAssigned to: None
Originator Name: Open/Closed: Closed
Release: devOperating System: GNU/Linux

Add a New Comment(Rich Markup)
   

You are not logged in

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

 

Wed 04 Sep 2013 03:25:36 PM UTC, comment #1:

The functions needs to be mentioned in spectral_xdf, spectral_adf because they are examples of a general type. The user can have any lag window they want provided they code a function for it and call it NAME_lw. In this case, Octave provides two commonly used windows--rectangle and triangle--and there is no need for a user to program these.

But you're right that they don't need to appear in the manual chapter signal.txi so I removed them in this changeset (http://hg.savannah.gnu.org/hgweb/octave/rev/3e95b22f5287).

Rik <rik5>
Project Administrator
Wed 04 Sep 2013 09:58:07 AM UTC, original submission:

This issue has been reported by Francesco Potortì against the Debian package for Octave:

http://bugs.debian.org/721802

according to which, the function triangle_lw is mentioned in the manual but is not accessible to the user.

Indeed, the functions rectangle_sw, rectangle_lw, triangle_sw, and triangle_lw have been made private in this commit:

http://hg.savannah.gnu.org/hgweb/octave/rev/0fed4935de94

By the same occasion, the corresponding @DOCSTRING() directives for those functions should have been removed from signal.txi, but they are still there:

http://hg.savannah.gnu.org/hgweb/octave/file/d70c99028ba3/doc/interpreter/signal.txi

Rafael Laboissiere <rlaboiss>

 

(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 rik5 (Posted a comment)
  • -unavailable- added by rlaboiss (Submitted the item)
  •  

    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 2 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Wed 04 Sep 2013 03:25:36 PM UTCrik5StatusNone=>Fixed
      Open/ClosedOpen=>Closed

    Back to the top


    Powered by Savane 3.1-cleanup1