By robertDouglass on

why is it necessary to start every README in the contributed modules with this sentence? Wouldn't it reflect on the programmer better to start out with "This module is a miracle of modern computer science defying all the normal laws of software development by elegantly masking inordinate complexity behind a simple and intuitive interface. It allows users to make a block on the left with a bunch of links...."

-Robert

Comments

marky’s picture

marky commented

Oh dear, I just *knew* this question would come up at some point...

Well I probably shouldn't be telling you this, but you see much as dentists are professionally obliged to say "This won't hurt..." when they know it will, it's a required phrase to demonstrate prowess and infinite wisdom in a given field. If we were ever to ($diety forbid) admit the code was so complex that even we didn't understand what was going on, where would civilization be now? Eh? Exactly...

It's actually clearly engraved in the "Guyde Buke Of Codynge" you *must* follow if your module is to be accepted as a "Worthye" contribution and you don't want your freinds to laugh at you behind your back and drink all your beer. Of course, I can't show you *where* it's written else I'd have to kill you.

/marky

ps. Please don't question our methods in future. We *do* know what's best for you after all.

pps. No, I don't have an amazon link for the book, sorry.

geokker’s picture

geokker commented

'This is a simple to use Module that...'