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

Incorrect sweep docs? #1799

Closed
A-Walrus opened this issue Apr 26, 2023 · 1 comment · Fixed by #1800
Closed

Incorrect sweep docs? #1799

A-Walrus opened this issue Apr 26, 2023 · 1 comment · Fixed by #1800
Labels
topic: documentation Improvements or additions to documentation type: bug Something isn't working

Comments

@A-Walrus
Copy link
Contributor

https://github.com/hannobraun/Fornjot/blob/a4d75d87245368b4ba964f1698ad898da4f209b6/crates/fj/src/lib.rs#L49-L50

It says that it is swept along the z axis, but from what I can tell it seems that it can be in any vector (length + direction):
https://github.com/hannobraun/Fornjot/blob/a4d75d87245368b4ba964f1698ad898da4f209b6/crates/fj/src/sweep.rs#L23-L24

I'd be happy to fix the docs, unless I'm missing something and it does indeed have to be in the z-axis

@hannobraun
Copy link
Owner

You are right, @A-Walrus, that documentation is outdated! It used to be a sweep along the z-axis (the user only provided the length), but it was changed to an arbitrary a long time ago.

@hannobraun hannobraun added type: bug Something isn't working topic: documentation Improvements or additions to documentation labels Apr 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Improvements or additions to documentation type: bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants