From: Mark Polesky <markpolesky@yahoo.com>
Date: Tue, 19 May 2009 06:18:38 +0000 (-0700)
Subject: Clarify 'avoid-slur docstring.
X-Git-Tag: release/2.13.1-1~7^2~3^2~5
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=ddbff5c8aef487bfed2f75b8490eb7a37afb0dc4;p=lilypond.git

Clarify 'avoid-slur docstring.
---

diff --git a/scm/define-grob-properties.scm b/scm/define-grob-properties.scm
index af9aa948d0..ce9ceaab4f 100644
--- a/scm/define-grob-properties.scm
+++ b/scm/define-grob-properties.scm
@@ -51,10 +51,14 @@ averaged over staves.")
      (avoid-note-head ,boolean? "If set, the stem of a chord does not
 pass through all note heads, but starts at the last note head.")
      (avoid-slur ,symbol? "Method of handling slur collisions.
-Choices are @code{around}, @code{inside}, @code{outside}.  If unset,
-scripts and slurs ignore each other.  @code{around} only moves the
-script if there is a collision; @code{outside} always moves the
-script.")
+Choices are @code{inside}, @code{outside}, @code{around}, and
+@code{ignore}. @code{inside} adjusts the slur if needed to keep the
+grob inside the slur. @code{outside} moves the grob vertically to the
+outside of the slur. @code{around} moves the grob vertically to the
+outside of the slur only if there is a collision. @code{ignore} does
+not move either. In grobs whose notational significance depends on
+vertical position (such as accidentals, clefs, etc.), @code{outside}
+and @code{around} behave like @code{ignore}.")
      (axes ,list? "List of axis numbers.  In the case of alignment
 grobs, this should contain only one number.")