From a3e416e2536b6aaf16fdeccdda6873ffb1d4888b Mon Sep 17 00:00:00 2001 From: Nils <> Date: Thu, 14 Apr 2022 23:36:01 +0200 Subject: [PATCH] docstring --- engine/instrument.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/engine/instrument.py b/engine/instrument.py index fb7707c..d693736 100644 --- a/engine/instrument.py +++ b/engine/instrument.py @@ -47,6 +47,12 @@ class Instrument(object): The order of variants in the config file will never change, it can only get appended. This way indexing will remain consistent over time. + NOTE CONCERNING THE BELOW: + The instruments are not really described by semantic versioning. That was the initial plan + but it showed that versioning of third party instruments is difficult or impossible. + But it also is not needed nor practical. New versions are so rare that one can easily + find individual schemes to name and differentiate variants. + The default variant after the first start (no save file) is the a special entry in metadata. It can change with new versions, so new projects will start with the newer file. @@ -56,7 +62,7 @@ class Instrument(object): SalamanderPiano1.6.sfz Here we have versions 1.2, 1.3 and 1.6. 4 and 5 were never released. A dropdown in a GUI - would show these four entries. + would show these entries. Patches are differentiated by the MINOR version as int. MINOR versions slightly change the sound. Typical reasons are retuning, filter changes etc.