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

Mutators tutorial doesn't give rotate_extrude example (and doc missing from mutators.scad wiki) #802

Closed
ochafik opened this issue Mar 14, 2022 · 6 comments · Fixed by #1259
Assignees

Comments

@ochafik
Copy link
Contributor

ochafik commented Mar 14, 2022

The rotate_extrude example given in the mutators tutorial is actually a linear_extrude.

Also none of them are documented in https://github.com/revarbat/BOSL2/wiki/mutators.scad :-)

@adrianVmariano
Copy link
Collaborator

rotate_extrude is a regular OpenSCAD module, not a BOSL2 module. Though clearly there's a mistake in the tutorial there, I think rotate_extrude was mentioned only to lead up to cylindrical_extrude.

@adrianVmariano
Copy link
Collaborator

Maybe the tutorial needs a link to the OpenSCAD manual for those functions?

@ochafik
Copy link
Contributor Author

ochafik commented Mar 15, 2022

Yes that would be good. Given how many of the stock modules are overridden, the BOSL2 doc & cheatsheet are now my only go to reference

@adrianVmariano
Copy link
Collaborator

I wonder if it makes sense to include at least minimal docs for base openscad modules in the BOSL2 docs.

@ochafik
Copy link
Contributor Author

ochafik commented Mar 16, 2022

As far as I'm concerned, a quick reminder of the signature + a very simple example (& link to the fuller official doc) would help.

@RAMilewski
Copy link
Contributor

I can't imagine doing anything in OpenSCAD without BOSL2. I added an issue in Antyos/vscode-openscad#38 asking for a 1-click open of the BOSL2 cheatsheet in the vscode-openscad extension to VSCode as it does with the OpenSCAD cheatsheet ...we'll see what happens.

The big problem with the OpenSCAD docs is that they're in WikiBooks and the search box there does a search of ALL of Wikibooks which is pretty much useless. So the cheatsheet is about the only useful link into them.

revarbat added a commit that referenced this issue Aug 19, 2023
@revarbat revarbat linked a pull request Aug 19, 2023 that will close this issue
revarbat added a commit that referenced this issue Aug 19, 2023
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

Successfully merging a pull request may close this issue.

4 participants