From 3695317526e21d338da3cc0f87e0ea36947c8128 Mon Sep 17 00:00:00 2001
From: Bert Palm <bert.palm@ufz.de>
Date: Fri, 5 Feb 2021 18:07:37 +0100
Subject: [PATCH] fixed docu
---
saqc/flagger/backtrack.py | 18 ++++++++++++++++--
1 file changed, 16 insertions(+), 2 deletions(-)
diff --git a/saqc/flagger/backtrack.py b/saqc/flagger/backtrack.py
index 381468260..4e36299e6 100644
--- a/saqc/flagger/backtrack.py
+++ b/saqc/flagger/backtrack.py
@@ -227,7 +227,7 @@ class Backtrack:
def max(self) -> pd.Series:
"""
- Get the maximum value per row of non-masked data.
+ Get the maximum value per row of the BT.
Returns
-------
@@ -240,6 +240,20 @@ class Backtrack:
return Backtrack
def copy(self, deep=True) -> Backtrack:
+ """
+ Make a copy of the BT.
+
+ Parameters
+ ----------
+ deep : bool, default True
+ - ``True``: make a deep copy
+ - ``False``: make a shallow copy
+
+ Returns
+ -------
+ copy : Backtrack
+ the copied BT
+ """
return self._constructor(bt=self, copy=deep)
def __len__(self) -> int:
@@ -275,7 +289,7 @@ class Backtrack:
def _validate_bt(self, obj: pd.DataFrame) -> pd.DataFrame:
"""
- check type, columns, index, dtype and if the mask fits the obj.
+ check type, columns, dtype of obj.
"""
if not isinstance(obj, pd.DataFrame):
--
GitLab