From a7976c0c3c2829dfd62e47a9f350738f6d0ba59f Mon Sep 17 00:00:00 2001 From: EdsonC Date: Sun, 15 Mar 2026 10:30:07 -0700 Subject: [PATCH 1/2] docs: improve vol_cuboid docstring with Wikipedia reference and math formula --- maths/volume.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/maths/volume.py b/maths/volume.py index 1715c9c300d5..90834f40314d 100644 --- a/maths/volume.py +++ b/maths/volume.py @@ -174,7 +174,9 @@ def vol_cuboid(width: float, height: float, length: float) -> float: """ Calculate the Volume of a Cuboid. - :return: multiple of `width`, `length` and `height` + Wikipedia reference: https://en.wikipedia.org/wiki/Cuboid + + :return: :math:`width \cdot height \cdot length` >>> vol_cuboid(1, 1, 1) 1.0 From 4185023483bd4d0ebc7ec9fff945ad69982cd54c Mon Sep 17 00:00:00 2001 From: EdsonC Date: Sun, 15 Mar 2026 11:33:29 -0700 Subject: [PATCH 2/2] fix: use raw string in vol_cuboid docstring to fix ruff W605 --- maths/volume.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/maths/volume.py b/maths/volume.py index 90834f40314d..65bca5b91109 100644 --- a/maths/volume.py +++ b/maths/volume.py @@ -171,7 +171,7 @@ def vol_spheres_union( def vol_cuboid(width: float, height: float, length: float) -> float: - """ + r""" Calculate the Volume of a Cuboid. Wikipedia reference: https://en.wikipedia.org/wiki/Cuboid