Beefy Boxes and Bandwidth Generously Provided by pair Networks
There's more than one way to do things
 
PerlMonks  

Re^2: An Introduction to Literate Programming with perlWEB

by swampyankee (Parson)
on Jan 13, 2009 at 16:41 UTC ( #735998=note: print w/replies, xml ) Need Help??


in reply to Re: An Introduction to Literate Programming with perlWEB
in thread An Introduction to Literate Programming with perlWEB

Architects don't design bridges; civil engineers do. They also record their stress and strain calculations in documents that are considered part of the drawing, and the engineer damn well better be able to produce them if they get sued*.

And while the contract you sign may not have all those lovely footnotes, the brief the lawyer presents to court probably will.


* And they will, even if the tort was because a piece of poo fell on them from a manure truck crossing the bridge.


Information about American English usage here and here. Floating point issues? Please read this before posting. — emc

  • Comment on Re^2: An Introduction to Literate Programming with perlWEB

Replies are listed 'Best First'.
Re^3: An Introduction to Literate Programming with perlWEB
by BrowserUk (Pope) on Jan 13, 2009 at 17:51 UTC
    Architects don't design bridges; civil engineers do.

    Tell that to the architect Norman Foster who designed the The Millau Viaduct (in conjunction with a French Structural Engineer).

    Stress calculation are obviously done, and checked and recorded and are an integral part of the overall design and documentation--but they don't do the calculations on the backs (or fronts) of the blue-prints. You don't put the two in the same document.

    And while the contract you sign may not have all those lovely footnotes,

    Exactly! You don't put them all in one document.

    I strongly support project documentation--what files, modules and libraries exist (and where), and what they do; the names of the public interfaces and their parameters; and their purpose--but you don't need to include the names of the internal variables, constants or explain how sort works.

    It's all about not mixing different concerns together; Not repeating effort (the DRY principle); and not creating unnecessary artificial dependencies (the decoupling principle).


    Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.
    "Science is about questioning the status quo. Questioning authority".
    In the absence of evidence, opinion is indistinguishable from prejudice.

      The drawing isn't the document; it's a part of the document, like Chapter XIV in Moby Dick. Maybe the difference is largely nomenclature, in that you're viewing the drawing as a product, analogously to a computer program, where I don't: it's a step, used to describe a part's geometry and no more a complete part description than "steel." On a drawing, one wouldn't say "bolt" without quite a lot of further information, like the size.

      From here on was added in an update.

      Oddly, I agree with many of your issues with LP, in that it adds a pre-processing layer, and even adds the complication of re-ordering code. I tend to view it as a very elaborate scheme of commentary, which may be a complete misinterpretation of its goals.


      Information about American English usage here and here. Floating point issues? Please read this before posting. — emc

        you're viewing the drawing as a product, analogously to a computer program, where I don't:

        As a one-time indentured draughtsman and qualified Mech.Eng, I can tell you that your interpretation is discordant with the way engineers view blueprints. Each blueprint has its own document no.; modifications history; title; keys; etc. They are "documents" in their own right. And in combination with materials lists--which sometimes are included on the drawings, they can be a complete specification for the manufacture of the product.


        Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.
        "Science is about questioning the status quo. Questioning authority".
        In the absence of evidence, opinion is indistinguishable from prejudice.

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://735998]
help
Chatterbox?
and the rats come out to play...

How do I use this? | Other CB clients
Other Users?
Others surveying the Monastery: (6)
As of 2018-07-19 10:10 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    It has been suggested to rename Perl 6 in order to boost its marketing potential. Which name would you prefer?















    Results (406 votes). Check out past polls.

    Notices?