Beefy Boxes and Bandwidth Generously Provided by pair Networks
go ahead... be a heretic
 
PerlMonks  

Re^2: Reorganizing or fixing Perl's documentation?

by Steve_p (Priest)
on Dec 21, 2004 at 17:17 UTC ( #416549=note: print w/replies, xml ) Need Help??


in reply to Re: Reorganizing or fixing Perl's documentation?
in thread Reorganizing or fixing Perl's documentation?

I've been working the perlbug queue for a while now, and the number of complaints on the Perl documentation has been very minimal. Most issues have been some slight nits, rewordings, and linking to other perldoc files for further examples. I have only found one case where code demonstrated in perldoc didn't work and one factual error in a FAQ (the FAQ claimed there was a Perl bug, when it was actually the underlying filesystem).

Perl and its documentation is all open source. If you don't like the documentation or have found a problem, please provide a patch. If you'd like a commentable Perldoc.com alternative, please build it. Don't like the current command-line perldoc? Develop a new one. The Perl community is run by volunteers, not a corporation like MySQL AB. If you'd like something done, do it!

By the way, the PODs for the current perl version are also all available at search.cpan.org. You can look up do in perlfunc.

Replies are listed 'Best First'.
Re^3: Reorganizing or fixing Perl's documentation?
by dragonchild (Archbishop) on Dec 21, 2004 at 17:19 UTC
    If you'd like a commentable Perldoc.com alternative, please build it.

    You willing to provide a host if I build the app and port over the current documentation?

    Being right, does not endow the right to be rude; politeness costs nothing.
    Being unknowing, is not the same as being stupid.
    Expressing a contrary opinion, whether to the individual or the group, is more often a sign of deeper thought than of cantankerous belligerence.
    Do not mistake your goals as the only goals; your opinion as the only opinion; your confidence as correctness. Saying you know better is not the same as explaining you know better.

      I've been working on plans for a "better perldoc" for a while now, so if you're going to work something I'd appreciate being contacted, so at least we can not duplicate mistakes. I've also got, at least for a while, a dedicated server I can use to host it.
        Should we start a mailing list and get down to brass tacks?

        Being right, does not endow the right to be rude; politeness costs nothing.
        Being unknowing, is not the same as being stupid.
        Expressing a contrary opinion, whether to the individual or the group, is more often a sign of deeper thought than of cantankerous belligerence.
        Do not mistake your goals as the only goals; your opinion as the only opinion; your confidence as correctness. Saying you know better is not the same as explaining you know better.

      I've been secretly building a "commentable Perl documentation web app", which I call AnnoCPAN (for Annotated CPAN). There are still some issues but it already works as a proof of concept. The problem is the hosting; I've been thinking I'll have to pay for a relatively inexpensive host so that I can at least show it to the world; I hope that if it is successful perhaps it could be possible to get some donations or a sponsor to get decent hosting.

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others imbibing at the Monastery: (6)
As of 2021-04-14 12:10 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?