Re: Doc: CG Clarifying about Examples with overrides (issue 7013043)

[pkx166h]

Reviewers: Trevor Daniels, phileholmes_googlemail.com,


https://codereview.appspot.com/7013043/diff/1/Documentation/contributor/doc-work.itexi
File Documentation/contributor/doc-work.itexi (right):

https://codereview.appspot.com/7013043/diff/1/Documentation/contributor/doc-work.itexi#newcode155
Documentation/contributor/doc-work.itexi:155: The correct way to add
[changes like this] to the documentation is to
On 2012/12/25 09:10:01, bealingsplayfordnews wrote:
> Why the [] ?

This is a standard way to to clarify the antecedent. Also you will see
it used to denote missing text [ ... ] or more commonly to denote a
mistake or inaccuracy in a quote without it being attributed to the
author of the text it is being quoted in (i.e '[sic]').

Anyway, enough of that, I have rewritten the sentence.

https://codereview.appspot.com/7013043/diff/1/Documentation/contributor/doc-work.itexi#newcode157
Documentation/contributor/doc-work.itexi:157: LilyPond Snippet
Repository (LSR).  It will then appear automatically in
On 2012/12/25 09:10:01, bealingsplayfordnews wrote:
> Please add a note to say that it must be tagged with docs, and should
be tagged
> with other relevant subject areas.  The tags dictate which section(s)
of the
> Snippets list that the snippet appears in.

This is already explained in the section that is referred to at the end
of the paragraph and which users should be reading anyway (section 7.0 -
specifically in 7.3). This paragraph is not a replacement for that.

https://codereview.appspot.com/7013043/diff/1/Documentation/contributor/doc-work.itexi#newcode161
Documentation/contributor/doc-work.itexi:161: it as a @emph{selected
snippet) in the position you suggest within the
On 2012/12/25 10:16:02, Trevor Daniels wrote:
> Change to
> " ... as a @emph{selected snippet), if appropriate, to the
documentation."

Done.

https://codereview.appspot.com/7013043/diff/1/Documentation/contributor/doc-work.itexi#newcode161
Documentation/contributor/doc-work.itexi:161: it as a @emph{selected
snippet) in the position you suggest within the
On 2012/12/25 11:01:33, PhilEHolmes wrote:
> This is Phil - as was the BealingsPlayford comment earlier.  Should
the closing
> ) be a } ?

Done.

Description:
Doc: CG Clarifying about Examples with overrides

Issue 3051

Paraphrased an email response sent by Trevor Daniels.

Please review this at https://codereview.appspot.com/7013043/

Affected files:
  M Documentation/contributor/doc-work.itexi


Index: Documentation/contributor/doc-work.itexi
diff --git a/Documentation/contributor/doc-work.itexi  
b/Documentation/contributor/doc-work.itexi
index  
ff6e0f07216048a90c71e31019fe01f0e79370a4..4d860e3cd3e61f947c3ed2bc23c89a4d114c2714  
100644
--- a/Documentation/contributor/doc-work.itexi
+++ b/Documentation/contributor/doc-work.itexi
@@ -146,6 +146,21 @@ Please prepare a formal git patch.

 @end enumerate

address@hidden that contain examples using overrides or tweaks
+
+Examples that use overrides, tweaks, customer Scheme functions etc. are
+(with very few exceptions) not included in the main text of the manuals;
+as there would be far too many, equally useful, candidates.
+
+The correct way to add [changes like this] to the documentation is to
+submit your example, with appropriate explanatory text and tags, to the
+LilyPond Snippet Repository (LSR).  It will then appear automatically in
+the Snippets lists.  See @ref{Introduction to LSR}.
+
+Once added as a snippet, documentation writers can then also easily add
+it as a @emph{selected snippet) in the position you suggest within the
+Notation Reference manual.
+
 Once you have followed these guidelines, please send a message to
 lilypond-devel with your documentation submissions.  Unfortunately
 there is a strict “no top-posting” check on the mailing list; to avoid