'help funname' fails to show multiple function names

Brought to you by: cerney, csopen, kgb, lambd, and 5 others

#274 'help funname' fails to show multiple function names

Milestone: feature_request

Status: closed-fixed

Owner: nobody

Labels: core (120)

Priority: 1

Updated: 2019-12-11

Created: 2011-06-14

Creator: Chris Marshall

Private: No

If you do a 'help max' in the perldl shell,
you get the docs for PDL::GSL::RNG::max but
not the ref for PDL::Ufunc::max which is
arguably more generally important.

This problem holds true for PDL::Ufunc::min
as well but things are ok for PDL::Ufunc::avg
and a number of other routines in PDL::Ufunc
so I do not believe this is a problem with the
PDL::Ufunc documentation.

PDL-2.4.9
cygwin/vista
perl 5.10.1

This is important to resolve as it can seriously
reduce the usability and friendliness of PDL
when the online docs can not be used to
find things out about the system...

Related

Discussion

Chris Marshall - 2011-06-14

There is not even an entry for max in the pdldoc.db file so
the limitation or problem starts with scantree.pl.

Once scantree.pl can put multiple functions with the same
name in the database, it will need to be verified whether
the pdldoc and help commands will support it.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Chris Marshall - 2011-06-14

Same problem with PDL::Index and PDL::Slices::index.
perldoc PDL::Index gives the correct response.
pdldoc PDL::Index gives 'No PDL docs for 'PDL::Index'. ...'

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Chris Marshall - 2011-06-14

Looking at the PDL::Doc code the current documentation
data structure does not have support for multiple functions
with the same name.

Maybe replacing the funcname => { } part by
funcname => [ { }, { } ] could work.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Chris Marshall - 2011-11-12

priority: 7 --> 6
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Chris Marshall - 2011-12-22

milestone: 101029 --> feature_request

priority: 6 --> 5

status: open --> open-later
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Chris Marshall - 2011-12-22

This issue will be addressed following the PDL-2.4.10 release.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Chris Marshall - 2015-02-22

Bug ticket triage for PDL-2.008. Priority >5 are desired for PDL-2.008.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Chris Marshall - 2015-02-22

Priority: 5 --> 1
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Derek Lamb - 2018-03-09

One possible solution is currently on the fix_docsys branch.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

mohawk - 2018-04-09

This matter will now be tracked at https://github.com/PDLPorters/pdl/issues/28

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Derek Lamb - 2019-12-11

status: open-later --> closed-fixed
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Derek Lamb - 2019-12-11

fixed at GitHub, closing this bug here at SF just because it feels good.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Log in to post a comment.