Skip to content

Commit 71a0daf

Browse files
Fix documentation build failure due to unescaped docstring characters
- Also include types to docstring args and returns Signed-off-by: Patrick Chin <8509935+thepatrickchin@users.noreply.github.com>
1 parent 0476752 commit 71a0daf

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

src/nat/eval/dataset_handler/dataset_filter.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class DatasetFilter:
2626
- If a allowlist is provided, only keep rows matching the filter values.
2727
- If a denylist is provided, remove rows matching the filter values.
2828
- If the filter column does not exist in the DataFrame, the filtering is skipped for that column.
29-
- Supports Unix shell-style wildcards (*, ?, [seq], [!seq]) for string matching
29+
- Supports Unix shell-style wildcards (``*``, ``?``, ``[seq]``, ``[!seq]``) for string matching.
3030
3131
This is a utility class that is dataset agnostic and can be used to filter any DataFrame based on the provided
3232
filter configuration.
@@ -42,11 +42,11 @@ def _match_wildcard_patterns(series: pd.Series, patterns: list[str | int | float
4242
Match series values against wildcard patterns and exact values.
4343
4444
Args:
45-
series: pandas Series to match against
46-
patterns: List of patterns/values
45+
series (pd.Series): pandas Series to match against
46+
patterns (list[str | int | float]): List of patterns/values
4747
4848
Returns:
49-
Boolean Series indicating matches
49+
pd.Series: Boolean Series indicating matches
5050
"""
5151
# Convert series to string for pattern matching
5252
str_series = series.astype(str)

0 commit comments

Comments
 (0)