bugGNU Octave - Bugs: bug #43725, [octave forge] website:...

 
 

bug #43725: [octave forge] website: find_function fails for class methods

Submitter:  None
Submitted:  Sat 29 Nov 2014 02:08:08 PM UTC
   
 
Category:  Octave Package Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Other
Status:  None Assigned to:  None
Originator Name:  Bill McEachen Originator Email:  -email is unavailable-
Open/Closed:  * Open Release:  * other
Operating System:  * Any Fixed Release:  None
Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Jump to the original submission

Sat 07 Feb 2015 09:28:40 PM UTC, comment #7: 

Indeed, it seems that package documentation generated with newer versions of generate_html no longer has links for the seealso help text.

I think getting them back would be useful.  Packages such as financial still make use of them http://octave.sourceforge.net/financial/function/eomdate.html

Carnë Draug <carandraug>
Group Member
Fri 06 Feb 2015 11:53:01 PM UTC, comment #6: 

To me, it looks like the find_function.php is a deprecated dispatcher for looking up the @seealso links.

When I use the current generate-html to create a package documentation, no seealso links are added to the HTML pages. Should they?

I found the octave_forge_seealso callback mechanism in the generate-html package. However, I could not get it to work. And if it worked, there would be direct links and would not use find_function.php.

Can this bug be closed?

Oliver Heimlich

Oliver Heimlich <oheim>
Fri 06 Feb 2015 11:52:34 PM UTC, comment #5: 

To me, it looks like the find_function.php is a deprecated dispatcher for looking up the @seealso links.

When I use the current generate-html to create a package documentation, no seealso links are added to the HTML pages. Should they?

I found the octave_forge_seealso callback mechanism in the generate-html package. However, I could not get it to work. And if it worked, there would be direct links and would not use find_function.php.

Can this bug be closed?

Oliver Heimlich

Anonymous
Tue 02 Dec 2014 02:04:06 PM UTC, comment #4: 

All the functions that are not found are in subfolders.

If the  php script
http://sourceforge.net/p/octave/project-web/ci/default/tree/htdocs/find_function.php
searched in subfolders then it would find the function.

The work-around has been to include the subfolders in the name for the see-also section of the docs.

Some package maintainers have done this and others have missed this.
"
See also: inputParser, @inputParser/addParamValue, @inputParser/addSwitch, @inputParser/addParamValue, @inputParser/addRequired, @inputParser/parse.

Package: general
"

I am not familiar enough with PHP to fix this. Hoping someone will fix the PHP because I think it is the better way to handle this.

Doug Stewart <dastew>
Tue 02 Dec 2014 12:25:28 PM UTC, comment #3: 

Source here https://sourceforge.net/p/octave/project-web/ci/default/tree/htdocs/ for anyone who knows javascript and would like to fix it.

There are two problems there.

1. the help text should be @seealso{@lti/dcgain} as otherwise, not even Octave itself knows where the help text is.

2. the javascript should indeed be able to find it.

Carnë Draug <carandraug>
Group Member
Sat 29 Nov 2014 04:45:33 PM UTC, comment #2: 

I also found that from
http://octave.sourceforge.net/control/function/@lti/sminreal.html

 the see also link for
See also: minreal

does not work.


I think the problem is in the find command of soureforge.

http://octave.sourceforge.net/find_function.php?fun=minreal

When it is looking for a function that is under the @...  (@lt1) folders it cant find them.

This is only a guess but it might help someone who knows php, where to look.

Doug Stewart <dastew>
Sat 29 Nov 2014 02:13:44 PM UTC, comment #1: 
Doug Stewart <dastew>
Sat 29 Nov 2014 02:08:08 PM UTC, original submission:  

from this link,
http://octave.sourceforge.net/control/function/@lti/freqresp.html

clicking on (see also) dcgain results in an error page.  I have the screenshot if you need it.

Anonymous

 

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

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by jwe (Updated the item)
  • -email is unavailable- added by oheim (Posted a comment)
  • -email is unavailable- added by dastew (Posted a comment)
  • -email is unavailable- added by None (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2017-08-13 jwe Summaryoctave forge website: find_function fails for class methods [octave forge] website: find_function fails for class methods
    2014-12-02 carandraug CategoryNone Octave Package
        Summarybad website link octave forge website: find_function fails for class methods

    Back to the top

    Powered by Savane 3.13-3230.
    Corresponding source code