Re: [dwm] Documentation!

From: Manfred Lotz <manfred.lotz_AT_arcor.de>
Date: Sat, 17 May 2008 12:17:35 +0200

Steffen Liebergeld wrote:
> Hi folks,
>
> after some time in proprietary environments I tried to get back to dwm.
> Unfortuately I was somewhat disappointed.
>
> Although I really appreciate your effort to simplify and reduce the code, it
> is now my impression that you drove it too far. The code is small as hell,
> and it might even be somewhat clever, but it is anything than
> self-documentary.
>
> Just have a look at that line:
> DEFGEOM(single, 0, 0, sw, 0, bh, sw, sh-bh, wx, wy, mfact*sw, wh, mx+mw,
> wy, ww-mw, wh, wx, wy, ww, wh)
>
> This is a true "wtf"! What the **** could that be? Could you at least
> document what this creature is? Do I have to read all the code, and
> understand it just to get the meaning of this single cryptic line.
>
>

Such cryptic variable names are ok if they are explained in a comment.

Generally I also like to have more comments throughout.

Why not simply omit empty lines and comment lines in the loc counting?
This would make much sense IMHO.

-- 
Manfred
Received on Sat May 17 2008 - 12:35:02 UTC

This archive was generated by hypermail 2.2.0 : Sun Jul 13 2008 - 15:39:59 UTC