Skip to content

docs: improve vol_cuboid docstring with Wikipedia reference and math formula. #14409

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

Open
Procodcj wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: improve vol_cuboid docstring with Wikipedia reference and math formula. #14409

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7976c0
docs: improve vol_cuboid docstring with Wikipedia reference and math …
Procodcj Mar 15, 2026
4185023
fix: use raw string in vol_cuboid docstring to fix ruff W605
Procodcj Mar 15, 2026
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
6 changes: 4 additions & 2 deletions maths/volume.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,10 +171,12 @@ def vol_spheres_union(


def vol_cuboid(width: float, height: float, length: float) -> float:
"""
r"""
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
Expand Down
Loading