Skip to content

Commit a7976c0

Browse files
committed
docs: improve vol_cuboid docstring with Wikipedia reference and math formula
1 parent 68473af commit a7976c0

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

maths/volume.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,9 @@ def vol_cuboid(width: float, height: float, length: float) -> float:
174174
"""
175175
Calculate the Volume of a Cuboid.
176176
177-
:return: multiple of `width`, `length` and `height`
177+
Wikipedia reference: https://en.wikipedia.org/wiki/Cuboid
178+
179+
:return: :math:`width \cdot height \cdot length`
178180
179181
>>> vol_cuboid(1, 1, 1)
180182
1.0

0 commit comments

Comments
 (0)