Skip to content
Snippets Groups Projects
Commit e83023c1 authored by Bert Palm's avatar Bert Palm 🎇
Browse files

Apply 6 suggestion(s) to 1 file(s)

parent fe73bbe2
No related branches found
No related tags found
1 merge request!218Flags
...@@ -14,7 +14,7 @@ class History: ...@@ -14,7 +14,7 @@ class History:
``append`` is called a new column is appended to the FH. The column ``append`` is called a new column is appended to the FH. The column
names are increasing integers starting with 0. After initialisation names are increasing integers starting with 0. After initialisation
the FH is empty and has no columns at all. If an initial `UNFLAGGED`- the FH is empty and has no columns at all. If an initial `UNFLAGGED`-
column is desired, it must created manually, or passed via the ``hist`` column is desired, it must be created manually, or passed via the ``hist``
parameter. The same way a new FH can be created from an existing one. parameter. The same way a new FH can be created from an existing one.
To get the worst flags (highest value) that are currently stored in To get the worst flags (highest value) that are currently stored in
...@@ -22,11 +22,11 @@ class History: ...@@ -22,11 +22,11 @@ class History:
the worst flag per row. the worst flag per row.
To counteract the problem, that one may want to force a better flag To counteract the problem, that one may want to force a better flag
value than the currently worst, ``append`` provide a ``force`` keyword. value than the current worst, ``append`` provide a ``force`` keyword.
Internal we need to store the force information in an additional mask. Internal we need to store the force information in an additional mask.
For more details and a detailed discussion, why this is needed, how this For more details and a detailed discussion, why this is needed, how this
works and possible other implementations, see #GH143 [1]. works and possible other implementations, see #GL143 [1].
[1] https://git.ufz.de/rdm-software/saqc/-/issues/143 [1] https://git.ufz.de/rdm-software/saqc/-/issues/143
...@@ -61,7 +61,7 @@ class History: ...@@ -61,7 +61,7 @@ class History:
mask = pd.DataFrame() mask = pd.DataFrame()
elif hist is None and mask is not None: elif hist is None and mask is not None:
raise ValueError("Cannot take 'mask' with no 'hist'") raise ValueError("Cannot take 'mask' without 'hist'")
elif hist is not None and mask is None: elif hist is not None and mask is None:
hist = self._validate_hist(hist) hist = self._validate_hist(hist)
...@@ -87,7 +87,7 @@ class History: ...@@ -87,7 +87,7 @@ class History:
Notes Notes
----- -----
The index should always be equal to the flags series, The index should always be equal to the flags series,
this is FH is associated with. If this is messed up the FH is associated with. If this is messed up
something went wrong in saqc internals or in a user- something went wrong in saqc internals or in a user-
defined test. defined test.
...@@ -223,7 +223,7 @@ class History: ...@@ -223,7 +223,7 @@ class History:
----- -----
The new column number (column name) will be the lowest of The new column number (column name) will be the lowest of
the squeezed. This ensure that the column numbers are always the squeezed. This ensure that the column numbers are always
monotonic increasing. monotonically increasing.
Bear in mind, this works inplace, if a copy is needed, call ``copy`` before. Bear in mind, this works inplace, if a copy is needed, call ``copy`` before.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment