docs: Deprecate getPlayerLabel function

Amsterdam-Music-Lab · Dec 11, 2023 · 348a2ff · 348a2ff
1 parent b02cc7c
commit 348a2ff
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/frontend/src/util/label.js b/frontend/src/util/label.js
@@ -5,7 +5,11 @@ export const LABEL_ALPHABETIC = "ALPHABETIC";
 export const LABEL_CUSTOM = "CUSTOM";
 export const LABEL_ROMAN = "ROMAN";
 
-// Get a player label, based on index, labelstyle and customLabels
+/**
+ * @deprecated This function is deprecated and will be removed in the future.
+ * See also https://github.com/Amsterdam-Music-Lab/MUSCLE/pull/640
+ * Get a player label, based on index, labelstyle and customLabels
+ */
 export const getPlayerLabel = (index, labelStyle, customLabels) => {
     index = parseInt(index);