develooper Front page | perl.perl6.internals | Postings from September 2005

[perl #37104] [PATCH] docs - spelling, markup and whitespace fixes

Thread Next
From:
Joshua Hoblitt
Date:
September 8, 2005 04:22
Subject:
[perl #37104] [PATCH] docs - spelling, markup and whitespace fixes
Message ID:
rt-3.0.11-37104-120427.16.9977757493344@perl.org
# New Ticket Created by  Joshua Hoblitt 
# Please include the string:  [perl #37104]
# in the subject line of all future correspondence about this issue. 
# <URL: https://rt.perl.org/rt3/Ticket/Display.html?id=37104 >


This patch is huge because of all the whitespace changes.  This was done
in an attempt to make the documentation more consistent, small and
easier to maintain. In no way was this an attempt to hide dirty
limericks being injected into the documentation. :)

Edited
    docs
    docs/dev
    docs/ops (skipped)
    docs/pdds (Pod markup only)
    docs/pmc (skipped)
    docs/req
    docs/resources (skipped)

Spell checking
    with the aspell-en 6.0.0 dictionary

Pod markup
    L<> around URLs
        identified by grep -rn "://" * | grep -Ev ".svn|L<"
    C<> around email addresses
        identified by grep -rn \@ * | grep -Ev ".svn|C<"
    C<> around function names
        as spotted
    F<> around dir & file paths
        as spotted

Whitespace
    paragraph reformatting
    line breaks at 80 char.
    don't allow word splits

docs/parrot.pod
    mention that Chip Salzenberg is the "chief architect"

docs/submissions.pod
    suggest using the diffstat utility

Disclaimer:  None of these corrections are exhaustive

 ROADMAP                  |  202 +++++++++----------
 compiler_faq.pod         |  106 ++++------
 configuration.pod        |  151 ++++++--------
 debug.pod                |  114 +++++------
 debugger.pod             |  172 +++++++---------
 dev/byteorder.dev        |   69 ++----
 dev/dod.dev              |  109 ++++------
 dev/events.pod           |  115 +++++------
 dev/infant.dev           |  196 ++++++++----------
 dev/jit_i386.dev         |    8
 dev/longopt.dev          |   52 ++---
 dev/pmc_freeze.pod       |  228 ++++++++++------------
 dev/rx.dev               |  162 +++++++--------
 embed.pod                |   69 +++---
 faq.pod                  |  485 +++++++++++++++++++++++------------------------ gettingstarted.pod       |  187 +++++++++---------
 glossary.pod             |  239 ++++++++++-------------
 intro.pod                |  111 ++++++----
 jit.pod                  |  180 ++++++++---------
 memory_internals.pod     |  140 ++++++-------
 mmd.pod                  |  142 ++++++-------
 native_exec.pod          |   60 ++---
 overview.pod             |  244 +++++++++++------------
 parrot.pod               |   75 +++----
 parrotbyte.pod           |   92 ++++----
 pdds/pdd00_pdd.pod       |    2
 pdds/pdd04_datatypes.pod |    2
 pdds/pdd14_bignum.pod    |    2
 pmc.pod                  |   22 +-
 porting_intro.pod        |    6
 req/model_users.pod      |   47 ++--
 running.pod              |   44 ++--
 strings.pod              |  199 +++++++++----------
 submissions.pod          |   91 ++++----
 tests.pod                |   61 ++---
 vtables.pod              |  222 ++++++++++-----------
 36 files changed, 2132 insertions(+), 2274 deletions(-)

Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About