[Surfraw-devel] Surfraw Style Guide RFC (was whitespace errors)
jasonwryan at gmail.com
Sun Oct 12 02:26:38 UTC 2014
On 11/10/14 at 01:19pm, Kyle Isom wrote:
> Here's a first pass at a STYLE file.
> ____ _______ ___ _____
> / ___|_ _\ \ / / | | ____|
> \___ \ | | \ V /| | | _|
> ___) || | | | | |___| |___
> |____/ |_| |_| |_____|_____|
> It's important to rage against the web in _style_. Fellow surfer,
> take these guidelines with you when developing revolutionary elvi:
> FOR STATEMENTS:
> for something in stuff
> for something in stuff ; do
> IF STATEMENTS:
> if rage ;
> if rage ; then
> INITIALISING VARIABLES WITH AN EMPTY STRING
> The var="" syntax is preferred over var=.
> Revolutionary elvi are of greatest utility when they are readable. If
> the consensus is that a breach of the style guide yields more readable
> code, the more legible option should be chosen.
> LEADING WHITESPACE
> Tabs are preferred.
> LINE LENGTH
> Lines should be wrapped at 80 characters so long as it doesn't require
> absurd contortions to fit this.
> LOCAL VARIABLE DECLARATION
> Function variables should be defined local. What happens in the
> function should stay in the function.
> PROCEESS SUBSTITUTION
> Use $() over `` for legibility.
> QUICHE EATING
> This is generally frowned upon.
http://jasonwryan.com/ [GnuPG Key: B1BD4E40]
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Size: 473 bytes
Desc: not available
More information about the Surfraw-devel