revarbat / BOSL

The Belfry OpenScad Library - A library of tools, shapes, and helpers to make OpenScad easier to use.
https://github.com/revarbat/BOSL/wiki
BSD 2-Clause "Simplified" License
557 stars 62 forks source link

[BUG] Documentation - Threading.scad - not mentioning slop only becomes effective if internal=true #82

Closed fe60 closed 3 years ago

fe60 commented 3 years ago

Describe the bug slop is only applied if the parameter internal is set to true. This should be mentioned in the documentation. Otherwise users not knowing the internals of BOSL could use the ..._rod modules under wrong assumptions.

Code To Reproduce Bug

d = internal? d+default(slop,PRINTER_SLOP)*3 : d;

https://github.com/revarbat/BOSL/blob/master/threading.scad#L99

Expected behavior The documentation should mention the relation between the parameters internal and slop.

fe60 commented 3 years ago

Fixed in fork of wiki https://github.com/fe60/bosl-wiki/commit/2e72363c3a199579e88d66859f6860f6a1ef2349