#4639 Doc - inconsistency for ly:context-pushpop-property with regart to 'override'

Paul Morris paul@paulwmorris.com writes:

The docs appear to be inconsistent about ly:context-pushpop-property.
Does it do a \temporary \override or just an \override ?

-Paul

---

ly:context-pushpop-property

do a \temporary \override or a \revert on a grob property

http://www.lilypond.org/doc/v2.19/Documentation/extending/context-evaluation

---

Function: ly:context-pushpop-property context grob eltprop val

Do a single \override or \revert operation in context. The grob
definition grob is extended with eltprop (if val is specified) or
reverted (if unspecified).

http://lilypond.org/doc/v2.19/Documentation/internals/scheme-functions

It does a "\temporary \override". Well spotted.

We also have the following definitions:

(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-music 'OverrideProperty
'symbol grob
'grob-property gprop
'grob-value val
'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-music 'OverrideProperty
'symbol grob
'grob-property gprop
'grob-value val))

Which we need to maintain for compatibility, along with
make-voice-props-set and make-voice-props-override and
override-heads-style.

In all of those cases, "override" means "\temporary \override" while
"set" means "\override".

Maybe one should at least fix the documentation strings. Like
"i.e., this is not a @code{\temporary \override}."

and "that temporarily overrides" or "that does a @code{\temporary
\override}".

Apart from inventing the actual \temporary command, I merely inherited
this mess. Before \temporary, there was just "\override" which did the
same as the Scheme functions "-set" rather than "-override", namely
always implying pop-first = #t .

--
David Kastrup

[Anonymous]

I have a patch done but am struggling getting git-cl to work. If I cannot get git-cl working I will upload the patch here so that we don't have others duplicating work.

[Anonymous]

Doc: scm - Clarify ly:context-pushpop-property

Issue 4639

Clarified when we mean
'\temporary \overrride'
and just '\overrride'.

http://codereview.appspot.com/274250043

[Anonymous]

With David K's corrections.

http://codereview.appspot.com/274250043

[Anonymous]

Put back accidentally deleted line - note to self: don't do edits when you are tired (and distracted).

http://codereview.appspot.com/274250043

[Anonymous]

Passes make, make check and a full make doc.

[Anonymous]

Patch on countdown for November 7th

[Anonymous]

Patch counted down - please push

[Anonymous]

author James Lowe pkx166h@gmail.com
Sun, 1 Nov 2015 15:02:54 +0000 (15:02 +0000)
committer James Lowe pkx166h@gmail.com
Sat, 7 Nov 2015 17:31:13 +0000 (17:31 +0000)
commit 0f3099177a2a23347b0a8c0895adbebc87d416be