BOSL2 icon indicating copy to clipboard operation
BOSL2 copied to clipboard

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

Open ochafik opened this issue 2 years ago • 5 comments

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 :-)

ochafik avatar Mar 14 '22 02:03 ochafik

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 avatar Mar 14 '22 02:03 adrianVmariano

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

adrianVmariano avatar Mar 14 '22 22:03 adrianVmariano

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

ochafik avatar Mar 15 '22 11:03 ochafik

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

adrianVmariano avatar Mar 15 '22 20:03 adrianVmariano

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

ochafik avatar Mar 16 '22 00:03 ochafik

I can't imagine doing anything in OpenSCAD without BOSL2. I added an issue in https://github.com/Antyos/vscode-openscad/issues/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.

RAMilewski avatar Mar 12 '23 22:03 RAMilewski