#298 pp_def, pp_line_numbers,..not found by pdldoc

critical
closed
core (120)
3
2013-10-07
2012-03-20
No

It appears that the docs for PDL::PP routines are not
being added to the PDL docs database. This makes
it difficult for developers or want to be developers
to discover the routines. E.g.,

$ pdldoc -a pp_line_numbers
no match

$ pdldoc pp_addhdr
No PDL docs for 'pp_addhdr'. Using 'whatis'. (Try 'apropos pp_addhdr'?)

This was for PDL-2.4.10 on a cygwin/vista platform.
I don't believe the issue is platform specific.

Discussion

  • Chris Marshall

    Chris Marshall - 2012-05-14

    The problem appears to be that the PP.pod does not use the standard convention for PDL documentation with routines under =head1 FUNCTIONS and introduced by =head2 funcname.

     
  • David Mertens

    David Mertens - 2012-05-14

    Chris, your guess is almost certainly correct. Sorry I haven't looked into it. I put this in the same bucket as CPAnified docs: nice to have, but not a high priority. Plus, this document is meant to be as much a tutorial as a reference document, so the =head1 FUNCTIONS seems a bit constricting to me. If/when I manage to write more chapters in the PDL Book for using PDL::PP, then I would change the PDL::PP docs to be a bona fide reference, pointing to the book for a tutorial approach.

     
  • Chris Marshall

    Chris Marshall - 2013-10-06

    It would be nice if at least enough were in PP.pod that help and apropos would at least give you a name and the fact that PP.pod has the more complete how-to-use as well. As it is now, there is no way to get documentation for the pp_xxx without knowing to look for
    PP. It would be nice if this could be fixed---at least this much for PDL-2.007

     
  • Chris Marshall

    Chris Marshall - 2013-10-07
    • status: open --> closed
    • assigned_to: Chris Marshall
    • Group: --> critical
     
  • Chris Marshall

    Chris Marshall - 2013-10-07

    Fixed in git for the coming PDL-2.007 release.

     

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks