[KPhotoAlbum] [PATCH 2/3] SettingsData: Default window geometry calculated

Henner Zeller h.zeller at acm.org
Wed Sep 24 09:19:26 BST 2008


Hi,
> I'm  somewhat of  a  disciple  of Saint  Knuth  and  his teachings  on
> literate  programming,  namely  that  code  should  be  considered  as
> something embedded in documentation (or  at least something that flows
> with a discussion). This seemed like a particularly good case in which
> to practice such a tradition.

Agreed to some extend. However, if it slows down reading and understanding the
code, then it is not a good idea.

A significant slowdown you get by not keeping the same formatting all
over the code.
So if you have good documentation between the lines, you should at
least have formatting you stick
to so that the eye is quick in parsing.

It would be different if you _always_ enforce that comments are only
half indented in the code base - then
it is simple to read. But having two practices in the same codebase is
slowing people down reading
the code.

> It's obvious I'm starting to step on toes,

At least on mine. But I am not the main-author of the project so I
have not much authority either ;)

>> it will be automatically indented to one level by the next editor.
>
> By 'editor', I  assume you mean software.

Both. The next person who has to deal with the code and that persons
editor software.

> There is  art and purpose in
> the indentation  I chose. It lends  itself to the discussion.  So, why
> should any  piece of  software be encouraged  to modify  these choices
> mindlessly?

It does only if you tell it to. But I tell my editor all the time to
take care of the indentation
of the line I am currently in so that I don't have to deal with that.
I could tell my editor software to only half-indent comment lines if
necessary ;-)

-h



More information about the Kphotoalbum mailing list