From 0f3099177a2a23347b0a8c0895adbebc87d416be Mon Sep 17 00:00:00 2001 From: James Lowe Date: Sun, 1 Nov 2015 15:02:54 +0000 Subject: [PATCH] Doc: scm - Clarify ly:context-pushpop-property Issue 4639 Clarified when we mean '\temporary \overrride' and just '\overrride'. --- lily/context-scheme.cc | 2 +- scm/music-functions.scm | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/lily/context-scheme.cc b/lily/context-scheme.cc index 169d0b7b3d..feda0f607e 100644 --- a/lily/context-scheme.cc +++ b/lily/context-scheme.cc @@ -76,7 +76,7 @@ LY_DEFINE (ly_context_grob_definition, "ly:context-grob-definition", LY_DEFINE (ly_context_pushpop_property, "ly:context-pushpop-property", 3, 1, 0, (SCM context, SCM grob, SCM eltprop, SCM val), - "Do a single @code{\\override} or @code{\\revert} operation" + "Do @code{\\temporary \\override} or @code{\\revert} operation" " in @var{context}. The grob definition @var{grob} is extended" " with @var{eltprop} (if @var{val} is specified) or reverted" " (if unspecified).") diff --git a/scm/music-functions.scm b/scm/music-functions.scm index 6e6d9c894b..d5a4b2478a 100644 --- a/scm/music-functions.scm +++ b/scm/music-functions.scm @@ -537,8 +537,9 @@ error (using optionally @code{location})." #f)))) (define-public (make-grob-property-set grob gprop val) - "Make a @code{Music} expression that sets @var{gprop} to @var{val} in -@var{grob}. Does a pop first, i.e., this is not an override." + "Make a @code{Music} expression that overrides a @var{gprop} to +@var{val} in @var{grob}. Does a pop first, i.e. this is not a +@code{\\temporary \\override}." (make-music 'OverrideProperty 'symbol grob 'grob-property gprop @@ -546,8 +547,9 @@ error (using optionally @code{location})." 'pop-first #t)) (define-public (make-grob-property-override grob gprop val) - "Make a @code{Music} expression that overrides @var{gprop} to @var{val} -in @var{grob}." + "Make a @code{Music} expression that overrides @var{gprop} to +@var{val} in @var{grob}. This is a @code{\\temporary \\override}, +making it possible to @code{\\revert} to any previous value afterwards." (make-music 'OverrideProperty 'symbol grob 'grob-property gprop -- 2.39.2