Skip to content

Improve math docs #24

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

Merged
merged 1 commit into from
Jul 23, 2024
Merged

Improve math docs #24

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
8 changes: 4 additions & 4 deletions src/frequenz/core/math.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# License: MIT
# Copyright © 2023 Frequenz Energy-as-a-Service GmbH

"""Internal math tools."""
"""Math tools."""

import math

Expand All @@ -15,11 +15,11 @@ def is_close_to_zero(value: float, abs_tol: float = 1e-9) -> bool:
For more technical details, see https://peps.python.org/pep-0485/#behavior-near-zero

Args:
value: the floating point value to compare to.
abs_tol: the minimum absolute tolerance. Defaults to 1e-9.
value: The floating point value to compare to.
abs_tol: The minimum absolute tolerance. Defaults to 1e-9.

Returns:
whether the floating point value is close to zero.
Whether the floating point value is close to zero.
"""
zero: float = 0.0
return math.isclose(a=value, b=zero, abs_tol=abs_tol)