Skip to content

Commit 28ccd05

Browse files
committed
Improve math docs
Fix some small issues, like the outdated module description mentioning it is internal, which is not true anymore. Also, fix some capitalization issues in the docstrings. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent c62020a commit 28ccd05

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/frequenz/core/math.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# License: MIT
22
# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
33

4-
"""Internal math tools."""
4+
"""Math tools."""
55

66
import math
77

@@ -15,11 +15,11 @@ def is_close_to_zero(value: float, abs_tol: float = 1e-9) -> bool:
1515
For more technical details, see https://peps.python.org/pep-0485/#behavior-near-zero
1616
1717
Args:
18-
value: the floating point value to compare to.
19-
abs_tol: the minimum absolute tolerance. Defaults to 1e-9.
18+
value: The floating point value to compare to.
19+
abs_tol: The minimum absolute tolerance. Defaults to 1e-9.
2020
2121
Returns:
22-
whether the floating point value is close to zero.
22+
Whether the floating point value is close to zero.
2323
"""
2424
zero: float = 0.0
2525
return math.isclose(a=value, b=zero, abs_tol=abs_tol)

0 commit comments

Comments
 (0)