Beefy Boxes and Bandwidth Generously Provided by pair Networks
XP is just a number
 
PerlMonks  

Reporting a Bug in Core Documentation

by kcott (Abbot)
on May 25, 2013 at 13:59 UTC ( #1035261=perlquestion: print w/ replies, xml ) Need Help??
kcott has asked for the wisdom of the Perl Monks concerning the following question:

G'day Monks,

I've found a bug in the perldelta for 5.18.0. I was about to report this via perlbug but then wondered if this was the best approach.

Here's the problem. Under perldelta (5.18.0) - Updated Modules and Pragmata, the entry for Scalar::Util includes information on functions from List::Util (i.e. sum, first and reduce). Also, the item marked "[rt.cpan.org #72700]" is a List::Util issue.

So, would perlbug be the correct utility to report this? If not, please advise a more appropriate tool. Thanks.

-- Ken

Comment on Reporting a Bug in Core Documentation
Select or Download Code
Re: Reporting a Bug in Core Documentation
by BrowserUk (Pope) on May 25, 2013 at 14:16 UTC
    Here's the problem. Under perldelta (5.18.0) - Updated Modules and Pragmata, the entry for Scalar::Util includes information on functions from List::Util (i.e. sum, first and reduce).

    List::Util & Scalar::Util are both actually distributed as a single package called Scalar-List-Utils.


    With the rise and rise of 'Social' network sites: 'Computers are making people easier to use everyday'
    Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.
    "Science is about questioning the status quo. Questioning authority".
    In the absence of evidence, opinion is indistinguishable from prejudice.

      Thanks for the reply. Yes, I did notice they were bundled in the one package.

      I get the feeling that you're implying something beyond simply stating that they're bundled together; however, if you are, I'm not sure what it is. Are you, for instance, suggesting that the entry should appear something like

      rather than having separate entries for the two modules?

      My intention was only to report that List::Util functions appeared under a Scalar::Util heading. My problem was that I wasn't sure if perlbug was the correct tool for the job.

      -- Ken

        I get the feeling that you're implying something

        Mostly just informational. Only that it may be intentional to treat the two modules as a single package.

        That's not to say it would not be better if both modules were treated separately; or at least both mention in the section header.

        I'm also unsure whether it is worth changing a delta document that becomes (kind of) redundant with the next release. But then again, a report might mean an improvement if the package requires a mention in the next delta.

        As far as I am aware (but don't definitively know; hence why I didn't comment on that first time around), perlbug is the right vehicle for doc changes. But I'd wait for someone who has had one accepted (or one of those that might accept or reject them) to reply before going ahead with it.


        With the rise and rise of 'Social' network sites: 'Computers are making people easier to use everyday'
        Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.
        "Science is about questioning the status quo. Questioning authority".
        In the absence of evidence, opinion is indistinguishable from prejudice.
Re: Reporting a Bug in Core Documentation
by syphilis (Canon) on May 26, 2013 at 04:40 UTC
    I was about to report this via perlbug but then wondered if this was the best approach.

    Yes, it's the best approach.

    Cheers,
    Rob

      Thanks Rob,

      After entering various pieces of information I get:

      $ perlbug ... Please pick a category from the following list: core docs install library utilities Category [core]: docs

      I've sent it off. I'll update with a ticket number when I get one.

      -- Ken

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: perlquestion [id://1035261]
Approved by BrowserUk
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others meditating upon the Monastery: (12)
As of 2014-10-31 17:17 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    For retirement, I am banking on:










    Results (221 votes), past polls