From: James Date: Sat, 16 Jan 2010 22:57:08 +0000 (+0000) Subject: Doc:Doc-work.itexi edits - LilyPond Formatting X-Git-Tag: release/2.13.12-1~115 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=2ea55763b607248cda6b2417f2fc70b905748bd5;p=lilypond.git Doc:Doc-work.itexi edits - LilyPond Formatting Removed dupe wording of 1 bar per line preferred Grouped few reqs together in a more logical order minor punctuation and grammar edits (expanded contractions, used third person not first) Reworded some phrases so it scans better --- diff --git a/Documentation/contributor/doc-work.itexi b/Documentation/contributor/doc-work.itexi index 24ff967f4f..9d6497c664 100644 --- a/Documentation/contributor/doc-work.itexi +++ b/Documentation/contributor/doc-work.itexi @@ -279,12 +279,16 @@ Again, LilyPond does not strictly require this, but it is a useful standard to follow. @item -Examples should end with a complete bar if possible. +If possible, only write one bar per line. @item -If possible, only write one bar per line. The notes on each -line should be an independent line -- tweaks should occur on their -own line if possible. Bad: +If you only have one bar per line, omit bar checks. If you +must put more than one bar per line (not recommended), then include bar +checks. + +@item +Tweaks should, if possible, also occur on their own line. +Bad: @example \override textscript #'padding = #3 c1^"hi" @@ -339,9 +343,9 @@ LSR snippets are linked with excepted in Templates, where `doctitle' may be omitted. @item -Avoid long stretches of input code. Noone is going to read -them in print. Please create a smaller example. (the smaller -example does not need to be minimal, however) +Avoid long stretches of input code. Nobody is going to read +them in print. Create small examples. However, this does not mean +it has be minimal. @item Specify durations for at least the first note of every bar. @@ -361,11 +365,6 @@ not: \chordmode @{c e g@} but instead: \chordmode @{ c e g @} @end example -@item -If you only have one bar per line, omit bar checks. If you -put more than one bar per line (not recommended), then include bar -checks. - @item If you want to work on an example outside of the manual (for easier/faster processing), use this header: @@ -396,9 +395,9 @@ Documentation Editor. @itemize @item -Lines should be less than 72 characters long. (I personally -recommend writing with 66-char lines, but don't bother modifying -existing material.) +Lines should be less than 72 characters long. (We personally +recommend writing with 66-char lines, but do not bother modifying +existing material). @item Do not use tabs.