Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pythonlib: Add missing docstring summary lines to fix D402 errors #5378

Merged
merged 1 commit into from
Mar 13, 2025
Merged

pythonlib: Add missing docstring summary lines to fix D402 errors #5378

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions python/grass/gunittest/checkers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,8 @@ def text_to_keyvalue(
# TODO: decide if None is valid, and use some default or no compare
# TODO: is None a valid value for precision?
def values_equal(value_a, value_b, precision: float = 0.000001) -> bool:
"""
"""Compare two values for equality within a given precision.

>>> values_equal(1.022, 1.02, precision=0.01)
True
>>> values_equal([1.2, 5.3, 6.8], [1.1, 5.2, 6.9], precision=0.2)
Expand Down Expand Up @@ -506,7 +507,8 @@ def lowercase_equals(string_a, string_b, precision=None):
# TODO: change parameter order?
# TODO: the behavior with last \n is strange but now using DOTALL and $
def check_text_ellipsis(reference, actual) -> bool:
r"""
r"""Check if actual text matches reference text with ellipsis as wildcards.

>>> check_text_ellipsis(
... "Vector map <...> contains ... points.",
... "Vector map <bridges> contains 5268 points.",
Expand Down Expand Up @@ -551,7 +553,8 @@ def check_text_ellipsis(reference, actual) -> bool:


def check_text_ellipsis_doctest(reference, actual):
"""
"""Check if actual text matches reference with ellipsis using doctest's matching.

>>> check_text_ellipsis_doctest(
... "user: ...\\nname: elevation", "user: some_user\\nname: elevation"
... )
Expand Down
Loading