]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/contributor/lsr-work.itexi
Doc: NR 1.8.1 addded @knownissue for Text Spanner
[lilypond.git] / Documentation / contributor / lsr-work.itexi
index 371aa6cedae3c959d1f7b18a8c4f6c21a0e7af98..94cf04ec1d5aa318a8591aa74383c52fcd3d02ba 100644 (file)
@@ -1,4 +1,4 @@
-@c -*- coding: us-ascii; mode: texinfo; -*-
+@c -*- coding: utf-8; mode: texinfo; -*-
 @node LSR work
 @chapter LSR work
 
@@ -61,7 +61,14 @@ scripts/auxiliar/makelsr.py
 
 @noindent
 This also copies translated texidoc fields and snippet titles into
-snippets in @file{Documentation/snippets}.
+snippets in @file{Documentation/snippets}.  Note: this, in turn, could
+make the translated texidoc fields to appear as out of sync when you
+run @code{make check-translation}, if the originals changed from the
+last translation update, even if the translations are also updated;
+see @ref{Documentation translation maintenance} for details about
+updating the docs; in particular, see @ref{Updating translation
+committishes} to learn how to mark these translated fields as fully
+updated.
 
 Be sure that @command{make doc} runs successfully before submitting a
 patch, to prevent breaking compilation.
@@ -106,6 +113,10 @@ the @qq{docs} tag and at least one other tag.
 If the snippet is tagged with @qq{docs}, check to see if it
 matches our guidelines for @ref{LilyPond formatting}.
 
+Also, snippets tagged with @qq{docs} should not be explaining
+(replicating) existing material in the docs.  They should not
+refer to the docs; the docs should refer to them.
+
 @item
 If the snippet uses scheme, check that everything looks good and
 there are no security risks.