Re: Remove deprecated context properties (issue 560030044 by address@hidden)

[v . villenave]

Reviewers: lemzwerg, thomasmorley651,

Message:
On 2020/05/09 20:17:09, thomasmorley651 wrote:
> Not sure about chordNameExceptionsFull and chordNameExceptionsPartial.
> I thought our deprecating policy would be to wait for 1 or even 2
stable
> versions before deleting from source.

Actually, all that was deprecated _long_ ago, much longer than 1 or 2
stable releases:
https://lists.gnu.org/archive/html/lilypond-user/2008-08/msg00389.html

I just made that clearer (and even added a convert-rule for
banter-style) :
https://git.savannah.gnu.org/cgit/lilypond.git/commit/?id=78225bc1b386e12dc1d03a5d2c7a017c0a52a22d

V.

Description:
Remove deprecated context properties

- bassFigureFormatFunction was dropped in 2.7.18 in favor of
figuredBassFormatter.  Removed throughout the doc, with a
convert rule.

- alignBassFigureAccidentals was deprecated even earlier, in 2.7.13.
Added to the aforementioned convert-rule.

- chordNameExceptionsFull and chordNameExceptionsPartial have been
deprecated at least since I rewrote the chord naming functions in
2.21.0; the only trace left is in the chord-names-alternative snippet.

Please review this at https://codereview.appspot.com/560030044/

Affected files (+36, -20 lines):
  M Documentation/ca/notation/rhythms.itely
  M Documentation/de/notation/rhythms.itely
  M Documentation/es/notation/rhythms.itely
  M Documentation/fr/notation/rhythms.itely
  M Documentation/it/notation/rhythms.itely
  M Documentation/ja/notation/rhythms.itely
  M Documentation/notation/rhythms.itely
  M Documentation/snippets/chord-names-alternative.ly
  M python/convertrules.py
  M scm/define-context-properties.scm


Index: Documentation/ca/notation/rhythms.itely
diff --git a/Documentation/ca/notation/rhythms.itely 
b/Documentation/ca/notation/rhythms.itely
index 
544ce11fcb914df5f53c06326b3603c8d0616afe..9f06b390463d9dd32df8d24225260ab6bb278899
 100644
--- a/Documentation/ca/notation/rhythms.itely
+++ b/Documentation/ca/notation/rhythms.itely
@@ -291,8 +291,8 @@ de grup especial, vegeu
 @cindex grups especials, format de
 @cindex tresets, format de
 
-@funindex tupletNumberFormatFunction
 @funindex tupletSpannerDuration
+@funindex \tupletSpan
 
 @lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle]
 {entering-several-tuplets-using-only-one--tuplet-command.ly}
Index: Documentation/de/notation/rhythms.itely
diff --git a/Documentation/de/notation/rhythms.itely 
b/Documentation/de/notation/rhythms.itely
index 
39ff710c89728d3fa485363a35da74d62884ca0e..a26eefea736d3ad48ecfe86ce4ccd1c91e360804
 100644
--- a/Documentation/de/notation/rhythms.itely
+++ b/Documentation/de/notation/rhythms.itely
@@ -269,8 +269,8 @@ zu setzen, siehe @ref{Tondauern skalieren}.
 @cindex Triole, Formatierung
 @cindex Formatierung von Triolen
 
-@funindex tupletNumberFormatFunction
 @funindex tupletSpannerDuration
+@funindex \tupletSpan
 
 @lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle]
 {entering-several-tuplets-using-only-one--tuplet-command.ly}
Index: Documentation/es/notation/rhythms.itely
diff --git a/Documentation/es/notation/rhythms.itely 
b/Documentation/es/notation/rhythms.itely
index 
8e827da1e73d277c3b5b6fb144f9fad167e9a4a9..a20b9d606138d6a0adb463b8aefc3215b6f1a8c3
 100644
--- a/Documentation/es/notation/rhythms.itely
+++ b/Documentation/es/notation/rhythms.itely
@@ -310,7 +310,6 @@ de grupo especial, véase @ref{Escalar las duraciones}.
 @cindex tresillo, formato de
 
 @cindex grupo especial, introducir muchos
-@funindex tupletNumberFormatFunction
 @funindex tupletSpannerDuration
 @funindex \tupletSpan
 @lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle]
Index: Documentation/fr/notation/rhythms.itely
diff --git a/Documentation/fr/notation/rhythms.itely 
b/Documentation/fr/notation/rhythms.itely
index 
8ac60ba8edd728e7a9f2341c89d528c3e0d86da1..dcf62e46c1e244af94e99bbf447bc6b12394f17c
 100644
--- a/Documentation/fr/notation/rhythms.itely
+++ b/Documentation/fr/notation/rhythms.itely
@@ -307,7 +307,6 @@ comme indiqué au chapitre @ref{Changement d'échelle des 
durées}.
 @cindex n-olet, formatage
 @cindex triolet, formatage
 @cindex n-olets successifs
-@funindex tupletNumberFormatFunction
 @funindex tupletSpannerDuration
 @funindex \tupletSpan
 @lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle]
Index: Documentation/it/notation/rhythms.itely
diff --git a/Documentation/it/notation/rhythms.itely 
b/Documentation/it/notation/rhythms.itely
index 
294dc2d34dc64078dd1ac2a51d429162114858db..7d6d7124d71560b36fe78deb3a3760362844c5b2
 100644
--- a/Documentation/it/notation/rhythms.itely
+++ b/Documentation/it/notation/rhythms.itely
@@ -308,7 +308,6 @@ quadra del gruppo irregolare, si veda @ref{Scalare le 
durate}.
 
 @cindex inserimento di gruppi irregolari multipli
 @cindex gruppo irregolare, inserirne multipli
-@funindex tupletNumberFormatFunction
 @funindex tupletSpannerDuration
 @funindex \tupletSpan
 @lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle]
Index: Documentation/ja/notation/rhythms.itely
diff --git a/Documentation/ja/notation/rhythms.itely 
b/Documentation/ja/notation/rhythms.itely
index 
ad56edf72a75de744106e7335e2166d33a681741..bee9a037a9d97c0bc985e4113c81d62bb1cfc08f
 100644
--- a/Documentation/ja/notation/rhythms.itely
+++ b/Documentation/ja/notation/rhythms.itely
@@ -296,8 +296,8 @@
 @cindex tuplet formatting (連符のフォーマット)
 @cindex triplet formatting (3 連符のフォーマット)
 
-@funindex tupletNumberFormatFunction
 @funindex tupletSpannerDuration
+@funindex \tupletSpan
 
 @lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle]
 {entering-several-tuplets-using-only-one--tuplet-command.ly}
Index: Documentation/notation/rhythms.itely
diff --git a/Documentation/notation/rhythms.itely 
b/Documentation/notation/rhythms.itely
index 
bc1cf97a37d893e95ac6f4a51ae265bbb30eca4c..1df8a26b90327be7ad763b29cbbb58389e9da047
 100644
--- a/Documentation/notation/rhythms.itely
+++ b/Documentation/notation/rhythms.itely
@@ -320,7 +320,6 @@ bracket is also introduced in @ref{Scaling durations}.
 
 @cindex entering multiple tuplets
 @cindex tuplet, entering multiple
-@funindex tupletNumberFormatFunction
 @funindex tupletSpannerDuration
 @funindex \tupletSpan
 @lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle]
Index: Documentation/snippets/chord-names-alternative.ly
diff --git a/Documentation/snippets/chord-names-alternative.ly 
b/Documentation/snippets/chord-names-alternative.ly
index 
525ea28a3ef5e6799c4a71198d59a54c2100441f..e3511932534bebd2a7ecc82d8c3b22f718c918a6
 100644
--- a/Documentation/snippets/chord-names-alternative.ly
+++ b/Documentation/snippets/chord-names-alternative.ly
@@ -43,6 +43,27 @@ introduced.
 #(define-public (jazz-chordnames pitches bass inversion context)
   (old_chord->markup 'jazz pitches bass inversion context))
 
+#(define (define-translator-property symbol type? description)
+  (if (not (and (symbol? symbol)
+    (procedure? type?)
+    (string? description)))
+      (ly:error "error in call of define-translator-property"))
+  (if (not (equal? (object-property symbol 'translation-doc) #f))
+      (ly:error (_ "symbol ~S redefined") symbol))
+
+  (set-object-property! symbol 'translation-type? type?)
+  (set-object-property! symbol 'translation-doc description)
+  symbol)
+
+#(for-each
+  (lambda (x)
+    (apply define-translator-property x))
+  `((chordNameExceptionsFull ,list? "An alist of full chord
+exceptions.  Contains @code{(@var{chord} . @var{markup})} entries.")
+    (chordNameExceptionsPartial ,list? "An alist of partial chord
+exceptions.  Contains @code{(@var{chord} . (@var{prefix-markup}
+@var{suffix-markup}))} entries.")))
+
 #(define-public (old_chord->markup
                 style pitches bass inversion context)
   "Entry point for @code{Chord_name_engraver}.
Index: python/convertrules.py
diff --git a/python/convertrules.py b/python/convertrules.py
index 
7ef80aeddfe7a2484147bc8a2dc52e2e16769575..9aa7343161092366ba9a636594549374ac3ee0fa
 100644
--- a/python/convertrules.py
+++ b/python/convertrules.py
@@ -2297,6 +2297,16 @@ def conv (str):
     return str
 
 
+@rule ((2, 7, 18), r"""bassFigureFormatFunction -> figuredBassFormatter
+deprecate alignBassFigureAccidentals.
+""")
+def conv (str):
+    str = re.sub ('bassFigureFormatFunction', 'figuredBassFormatter', str)
+    if re.search ('alignBassFigureAccidentals', str):
+        stderr_write (NOT_SMART % "alignBassFigureAccidentals")
+    return str
+
+
 @rule ((2, 7, 22), r"\tag #'(a b) -> \tag #'a \tag #'b")
 def conv (str):
     def sub_syms (m):
Index: scm/define-context-properties.scm
diff --git a/scm/define-context-properties.scm 
b/scm/define-context-properties.scm
index 
bd170810836089cec196a001c398b8b175032d00..7ce88f9ca654bcc6703ff6f0ac1fac91aaa7412c
 100644
--- a/scm/define-context-properties.scm
+++ b/scm/define-context-properties.scm
@@ -55,8 +55,6 @@ string (starting with the lowest numbered one).")
 additional pitches within a chord name.")
      (alignAboveContext ,string? "Where to insert newly created context in
 vertical alignment.")
-     (alignBassFigureAccidentals ,boolean? "If true, then the accidentals
-are aligned in bass figure context.")
      (alignBelowContext ,string? "Where to insert newly created context in
 vertical alignment.")
      (alternativeNumberingStyle ,symbol? "The style of an alternative's bar
@@ -175,10 +173,6 @@ must be set to@tie{}3 and @var{m}@tie{}(the division 
remainder) to@tie{}1.
 
      (baseMoment ,ly:moment? "Smallest unit of time that will stand on its
 own as a subdivided section.")
-     (bassFigureFormatFunction ,procedure? "A procedure that is
-called to produce the formatting for a @code{BassFigure} grob.  It
-takes a list of @code{BassFigureEvent}s, a context, and the grob to
-format.")
      (beamExceptions ,list? "An alist of exceptions to autobeam rules
 that normally end on beats.")
      (beamHalfMeasure ,boolean? "Whether to allow a beam to begin
@@ -189,11 +183,6 @@ to make beats.")
      (chordChanges ,boolean? "Only show changes in chords scheme?")
      (chordNameExceptions ,list? "An alist of chord exceptions.
 Contains @code{(@var{chord} . @var{markup})} entries.")
-     (chordNameExceptionsFull ,list? "An alist of full chord
-exceptions.  Contains @code{(@var{chord} . @var{markup})} entries.")
-     (chordNameExceptionsPartial ,list? "An alist of partial chord
-exceptions.  Contains @code{(@var{chord} . (@var{prefix-markup}
-@var{suffix-markup}))} entries.")
      (chordNameFunction ,procedure? "The function that converts lists
 of pitches to chord names.")
      (chordNameLowercaseMinor ,boolean? "Downcase roots of minor chords?")
@@ -616,6 +605,8 @@ accidentals are typeset as suggestions above the note.  
Setting it to
 @code{'cautionary} only applies that to cautionary accidentals.")
      (supportNonIntegerFret ,boolean? "If set in @code{Score} the
 @code{TabStaff} will print micro-tones as @samp{2½}")
+     (suspendRestMerging ,boolean? "When using the Merge_rest_engraver do not
+                         merge rests when this is set to true.")
      (systemStartDelimiter ,symbol? "Which grob to make for the start
 of the system/@/staff?  Set to @code{SystemStartBrace},
 @code{SystemStartBracket} or @code{SystemStartBar}.")
@@ -686,8 +677,6 @@ Example:
 @noindent
 This will create a start-repeat bar in this staff only.  Valid values
 are described in @file{scm/bar-line.scm}.")
-     (suspendRestMerging ,boolean? "When using the Merge_rest_engraver do not
-                         merge rests when this is set to true.")
      )))