release: 1.5.48

[lilypond.git] / lily / beam.cc

diff --git a/lily/beam.cc b/lily/beam.cc
index 98b674ce8439e6a40449925138347d2ab4ab3e46..23bd41dbaa7330061f38004a0c7bd8f9069a57d1 100644 (file)
--- a/lily/beam.cc
+++ b/lily/beam.cc
@@ -1341,6 +1341,19 @@ ADD_INTERFACE (Beam, "beam-interface",
   "A beam.
 
 #'thickness= weight of beams, in staffspace
-  ",
+
+
+We take the least squares line through the ideal-length stems, and
+then damp that using
+
+       damped = tanh (slope)
+
+this gives an unquantized left and right position for the beam end.
+Then we take all combinations of quantings near these left and right
+positions, and give them a score (according to how close they are to
+the ideal slope, how close the result is to the ideal stems, etc.). We
+take the best scoring combination.
+
+",
   "concaveness-threshold dir-function quant-score auto-knee-gap gap chord-tremolo beamed-stem-shorten shorten least-squares-dy direction damping flag-width-function neutral-direction positions thickness");