From: Graham Percival <graham@percival-music.ca>
Date: Wed, 2 Dec 2009 04:47:03 +0000 (+0000)
Subject: Doc: CG: add info about docstrings.
X-Git-Tag: release/2.13.9-1~48
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=58691bcb99dc78f99453916fc4da221f43f6940e;p=lilypond.git

Doc: CG: add info about docstrings.
---

diff --git a/Documentation/contributor/doc-work.itexi b/Documentation/contributor/doc-work.itexi
index 0ca1fcb5b6..959f206886 100644
--- a/Documentation/contributor/doc-work.itexi
+++ b/Documentation/contributor/doc-work.itexi
@@ -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