[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Issue 990 in lilypond: automatically include property-init.ly in doc
From: |
lilypond |
Subject: |
Re: Issue 990 in lilypond: automatically include property-init.ly in docs |
Date: |
Thu, 02 Feb 2012 20:16:05 +0000 |
Comment #3 on issue 990 by address@hidden: automatically include
property-init.ly in docs
http://code.google.com/p/lilypond/issues/detail?id=990
I am not sure what to make of this issue. property-init.ly _is_ included
in the documentation (check out \xNotesOn in "Available music functions")
so the "maybe we could extend the system for the Internals to apply to the
init files somehow?" comment does not seem to make much sense. It is just
that most of its contents is plain music variables and thus without DOC
strings (letting arbitrary identifiers register DOC strings would be
reasonably easy to do: wasn't there a separate issue for that already?).
Now the code itself is also instructive, but not authoritive: it may change
from one version to the next, depending on how features are implemented via
properties.
So like music-functions-init.ly, I consider it a good idea to point to this
as an instructive example and inspiration, but I don't think it belongs in
the documentation proper.
What could belong in there are documentation strings for music variables.
That would require three issues (in decreasing order of importance; 1 is
obviously a prerequisite for the rest, 3 is just cleanup):
1) create a way of documenting variables ending up in our documentation.
2) document the variables worthy of doing so.
3) change argumentless music functions that are music functions only
because of their
DOC string back into variables.
Those look like a more concrete plan than this issue.
- Re: Issue 990 in lilypond: automatically include property-init.ly in docs,
lilypond <=