Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl Monk, Perl Meditation

Comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

Much (in a great way) like (similar to) a (singular article) sentence (grouping of words expressing an idea) doesn't (fails to) make (produce) sense (coherent meaning) without (lacking) the (definite article) definition (explanation of meaning) of (preposition) words (grouping of lettings expressing a concept).

Make your reader's life easy by keeping the word definitions as close as possible to the words! It would be crazy to have a separate document that explains the basics and then to expect your copy editor to actually understand the meaning of English words before she jumps in trying to edit your sentences.

Oh, some of my definitions above rather suck. I find that often happens when I'm forced to shift tasks in the middle of composing a sentence and throw together a word definition in order to get the boilerplate in place so I can type in the next word

Touchy (french for bullseye)!

The difference is it isn't like english prose, its more like dictionary

=head2 C<< Much >> a definition =cut sub Much { "in a great way"; } =head2 C<< like >> a definition =cut sub like { "similar to"; } =head2 C<< a >> a definition =cut sub a { "singular article"; } =head2 C<< sentence >> a definition =cut sub sentence { "grouping of words expressing an idea"; } =head2 C<< doesn't >> a definition =cut sub doesn't { "fails to"; } =head2 C<< make >> a definition =cut sub make { "produce"; } =head2 C<< sense >> a definition =cut sub sense { "coherent meaning"; } =head2 C<< without >> a definition =cut sub without { "lacking"; } =head2 C<< the >> a definition =cut sub the { "definite article"; } =head2 C<< definition >> a definition =cut sub definition { "explanation of meaning"; } =head2 C<< of >> a definition =cut sub of { "preposition"; } =head2 C<< words >> a definition =cut sub words { "grouping of lettings expressing a concept"; }

In reply to Re^3: Documentation: POD vs Comments (proximity is not clarity) by Anonymous Monk
in thread Documentation: POD vs Comments by ravenclaw

Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":

  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?

    What's my password?
    Create A New User
    and all is quiet...

    How do I use this? | Other CB clients
    Other Users?
    Others cooling their heels in the Monastery: (7)
    As of 2018-06-21 20:34 GMT
    Find Nodes?
      Voting Booth?
      Should cpanminus be part of the standard Perl release?

      Results (119 votes). Check out past polls.