Re^2: Perl documentation documentation

http://www.perlmonks.org?node_id=408388

in reply to Re: Perl documentation documentation
in thread Perl documentation documentation

I don't call newbies "cretins", and I realize that a lot of people just don't know where to start.

But then, I'm only half serious about this new documentation anyway.

--
brian d foy <bdfoy@cpan.org>

Comment on Re^2: Perl documentation documentation

Replies are listed 'Best First'.
Re^3: Perl documentation documentation by periapt (Hermit) on Nov 17, 2004 at 14:01 UTC
Actually, tongue and cheek aside, I think this is a much needed piece of work. I usually refer to the Camel or LLama when I have a question because I find perldoc a little too counterintuitive for quick reference. I know others don't have a problem with perdoc but many a time I've heard newbies (and a few old salts) express frustration at not being able to get at the answer they just knew was in the documentation. It's not that they didn't know to look, they just didn't know how to look. I know this was partly in fun but maybe make it a little less flip (the newbie reading over my shoulder thought it was a little patronizing) and you may have hit on something valuable. PJ use strict; use warnings; use diagnostics;	[reply]
Re^4: Perl documentation documentation by bwelch (Curate) on Nov 17, 2004 at 16:02 UTC
Seconded! I believe this could be valuable to many people. One might consider expanding it a bit to show easy ways to look up different things. Examples of searching for syntax questions, cookbook methods, algorithms, and common modules might be just what people want in some cases.	[reply]
Re^4: Perl documentation documentation by Ytrew (Pilgrim) on Nov 18, 2004 at 05:29 UTC
I think it's actually a reasonable piece of documentation; it contains at least one piece of information that I didn't know for several years after using perl. Specifically, it took me about three years before I realized that the perldoc command had the "-f" switch. When I first started learning perl, I usually wanted to read the entire manual page, anyway. To my mind (and perhaps in the earlier versions of perldoc, I don't remember now), "perldoc" <topic> and "man" <topic> were essentially equivalent. It wasn't until I moved to the ActiveState release of perl (with no man pages under Windows), that I realized how useful "perldoc -f" was. So I'd support the notion of "meta-documentation" for that reason alone. Additionally, online documentation written for different intended audience than the traditional CS student with a background in C and UNIX might be helpful as well. -- Ytrew	[reply]
Re^3: Perl documentation documentation by dragonchild (Archbishop) on Nov 17, 2004 at 13:17 UTC
That's a good thing, cause otherwise I'd have to propose the name `perldocdoc`. ;-) 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.	[reply] [d/l]
Re^3: Perl documentation documentation by Anonymous Monk on Sep 14, 2005 at 01:55 UTC
I totally agree with this. I was looking for a training in perl. Someone finally sent me the perlmonks.org/tutorials link. Hey, you don't believe it, I can $myscalar = "perl now"; print "$myscalar\n, Huh!!" ;	[reply]

In Section Tutorials