Beefy Boxes and Bandwidth Generously Provided by pair Networks
Syntactic Confectionery Delight
 
PerlMonks  

proposal for the Clarification Code section

by Discipulus (Curate)
on Sep 25, 2002 at 11:42 UTC ( #200601=monkdiscuss: print w/ replies, xml ) Need Help??

I all monks, I'm just a initiate and I'm quiet new in Perl Craft, and like me I think there are many peoples in the Monastery. For these reason I propose a section dedicated to the understanding of good syntax.
I think that Obfusctated is funny (maybe only for Pontiffs &HolyCompany) but is very difficult for us to learn something from it.
My idea is a section dedicated to very-well-commented code where we (initiates&Company) can learn about "good" syntax explained by authors. Maybe a good idea is put different examples to accomplish the same task commented.
I felt that the Monastry is a place where improve skill.. so help the little ones. Maybe I'm wrong but may be not.

Thanks in advance
and greetings from roma
lorenzo\discipulus*

Comment on proposal for the Clarification Code section
Re: proposal for the Claerification Code section
by RMGir (Prior) on Sep 25, 2002 at 12:16 UTC
    I think the Code Catacombs, Tutorials, Snippets Section, and Craft sections already serve that purpose, although not all posts there meet your criteria.

    Adding yet another section would simply add (more) confusion about where to post a given example/explanation...
    --
    Mike

Re: proposal for the Claerification Code section
by Django (Pilgrim) on Sep 25, 2002 at 12:24 UTC

    There's a lot of that going on in SOPW, but I think it would be nice to have a special section for it too. Maybe the "Craft" section was originally intended for that purpose, but most code there is completely uncommented, and there are few alternative solutions. The distinction between "Code" and "Snippets" seems to be clear, but what's the actual distinction to "Craft"?

    ~Django
    "Why don't we ever challenge the spherical earth theory?"

      According to the Site how-to, Craft was originally created to show off code users were particularly proud of. I don't think that means that Craft was created for well documented code, as I know code I'm proudest of is either so lucid that a beginner could understand it on second pass, or so obfuscated that the point is to not understand it till you read through it. I believe that the Code Catacombs would be more appropriate to post full, well documented code, as that probably has a larger content limit (I'd assume).

      To Discipulus, I don't think that a new section necessarily needs to be created for authors to repost revised code. Personally, I think the best thing to do as a novice is to slug through some of the Code and craft by yourself with a fresh console window with perldoc waiting to answer any syntax questions. Also, PLEASE read perldoc perlsyn before making suggestions on where syntax sections are needed. This isn't a simple "RTFM", but in truth all the syntax instruction a beginner needs comes in perlsyn. Finally (and this is the important one) my suggestion to you: ask the authors. If you go through the Code and Craft section, you'll find lots of clear examples of perl in use, but also the wealth of information that is other monks. I've never seen one monk belittle another for asking a question about his or her code.
      Have fun at the monastery, it's a great place to learn, and even laugh sometimes ;) (the latter half up to here is to Discipulus, not Django)
(no) Re: proposal for the Claerification Code section
by PodMaster (Abbot) on Sep 26, 2002 at 07:38 UTC
    Good syntaxt is relatively easily understood.

    A section dedicated to "good syntaxt" is not needed, in the same manner that a section dedicated to "perl style" is not needed.

    They would both be very very short sections (and good style is good syntaxt).

    A tutorial on "good" syntaxt and style for our Tutorials section might not be a bad idea. I'll notify ybiC

    perlstyle

    ____________________________________________________
    ** The Third rule of perl club is a statement of fact: pod is sexy.

Re: proposal for the Claerification Code section
by Flexx (Pilgrim) on Sep 26, 2002 at 18:06 UTC

    Hi Discipulus!

    You have a good point. I also think that a section where "moderated" code would go might be a sound addition to the monasteries' libraries. Those writeups could have a before/after section at the very top, or even a diff history or something..

    Oh, but I didn't want to dwelve into my imagination -- I just wanted to point you to The Perl Cookbook by the great Tom Christiansen and Nathan Torkington, since this might provide you with the kind of information you're looking for: Examples of how to make Perl shine...

    Also check out the Q&A section. There are a lot of receipes, and "how to" questions, too. To request critique on your own code output, you can always use the code and/or SOPW sections...

    So long,
    Flexx

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: monkdiscuss [id://200601]
Approved by TStanley
Front-paged by wil
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others taking refuge in the Monastery: (14)
As of 2014-08-20 18:02 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    The best computer themed movie is:











    Results (121 votes), past polls