RE: Fret Diagram markup

[Heikki Johannes Junes]

On Tue, 18 May 2004 15:43:07 -0600 "Carl D. Sorensen" <address@hidden> wrote:

> 
> 
> > -----Original Message-----
> > From: Han-Wen Nienhuys [mailto:address@hidden 
> > [...]
> > I would like to start integrating your file into
> scm/fret-diagrams.scm
> > - however, could I ask you to use hyphenated chord names? 
> > When fret-diagrams.scm enters the Lilypond distribution, we 
> > have to take over maintainership (for name changes in the 
> > Scheme API).  Having a uniform coding style really helps us 
> > work with the code.
> > 
> 
> 
> Do you mean hyphenated variable names?
> 
> Carl Sorensen

There is a very simple rule. If the variable name consists of two english words,
there is always a hyphenation character between. If there are three english
words, there are always two hyphenation characters. 

There is nothing wrong to use variable names which consist of several words, use
just some space character between, in this case the hyphenation character. Such
a convention makes it easier to read the code, and effectively leads to a
situation in which there is less need to add extra comment lines. When using
long variable names you may not need to separately document why the variable is
used since its name is self-explanatory.

-- 
  Heikki Junes