]> git.donarmstrong.com Git - lilypond.git/commitdiff
Doc: CG: add info about docstrings.
authorGraham Percival <graham@percival-music.ca>
Wed, 2 Dec 2009 04:47:03 +0000 (04:47 +0000)
committerGraham Percival <graham@percival-music.ca>
Wed, 2 Dec 2009 04:47:36 +0000 (04:47 +0000)
Documentation/contributor/doc-work.itexi

index 0ca1fcb5b6dfe7e89dabdc82b1cb48f8c5fbcea7..959f206886817b86ed621d60854b0c508c87d714 100644 (file)
@@ -19,6 +19,7 @@ Version Control System (VCS) called git, previously discussed in
 * Documentation policy::
 * Tips for writing docs::
 * Updating docs with convert-ly::
+* Docstrings in scheme::
 * Translating the documentation::
 @end menu
 
@@ -1083,6 +1084,18 @@ This also updates translated documentation.
 
 
 
+@node Docstrings in scheme
+@section Docstrings in scheme
+
+Material in the Internals reference is generated automatically
+from our source code.  Any doc work on Internals therefore
+requires modifying files in @file{scm/*.scm}.  Texinfo is allowed
+in these docstrings.
+
+Most documentation writers never touch these, though.  If you want
+to work on them, please ask for help.
+
+
 @node Translating the documentation
 @section Translating the documentation