Add deprecation notice for PovWdl tuple like behavior

niklasf · Oct 22, 2020 · bbf87db · bbf87db
1 parent a07d343
commit bbf87db
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/chess/engine.py b/chess/engine.py
@@ -736,6 +736,12 @@ class PovWdl:
     """
     Relative :class:`win/draw/loss statistics <chess.engine.Wdl>` and the point
     of view.
+
+    .. deprecated:: 1.2
+        Behaves like a tuple
+        ``(wdl.relative.wins, wdl.relative.draws, wdl.relative.losses)``
+        for backwards compatibility. But it is recommended to use the provided
+        fields and methods instead.
     """
 
     relative: Wdl