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

Docs: Note that the radius arg of bd.Helix is the "minimum radius" when cone_angle>0 #761

Open
KilowattSynthesis opened this issue Nov 5, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@KilowattSynthesis
Copy link

KilowattSynthesis commented Nov 5, 2024

When cone_angle>0, the cone of the helix expands outwards (thus making the radiux arg the "minimum radius"). The docs don't currently mention this.

@gumyr gumyr added the documentation Improvements or additions to documentation label Nov 5, 2024
@gumyr gumyr added this to the Not Gating Release 1.0.0 milestone Nov 5, 2024
@gumyr
Copy link
Owner

gumyr commented Nov 9, 2024

If the cone_angle<0 the helix gets smaller as it proceeds so the radius isn't the "minimum" but maybe the "base" radius.

@KilowattSynthesis
Copy link
Author

Hmm good note; hadn't considered that. I don't think "base" radius is necessarily clear, as it's not clear what "base" means (I guess it's the radiux closest to the orgin?).

Perhaps:

When cone_angle != 0, the radius argument is the radius at the side of the cone closest to the origin. When cone_angle > 0, the radius expands outwards farther from the origin; when cone_angle < 0, the radius spirals inwards.

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

No branches or pull requests

2 participants