Skip to content
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.

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

height is used in a 2-dimensional-sense in the docs and it is wrong/confusing #1772

Open
inktrap opened this issue Feb 17, 2025 · 0 comments

Comments

@inktrap
Copy link

inktrap commented Feb 17, 2025

Useage of height in docs/examples is unexpected. E.g.: https://cadquery.readthedocs.io/en/latest/examples.html#plate-with-hole

# The dimensions of the box. These can be modified rather than changing the
# object's code directly.
length = 80.0
height = 60.0
thickness = 10.0
center_hole_dia = 22.0

# Create a box based on the dimensions above and add a 22mm center hole
result = (
    cq.Workplane("XY")
    .box(length, height, thickness)
    .faces(">Z")
    .workplane()
    .hole(center_hole_dia)
)

The module docs state that box() takes length, width, height which is conventional and expected. Calling it with length, height, thickness is confusing. The underlying issue here is that height is used in a 2-dimensional-sense, so I would advocate for using length, width, height consistently in all examples and to not bother with thickness, and more importantly, to use width instead of height.

I also noticed this is in the first example I worked through and started to edit the docs but had the need to discuss this first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant