diff --git a/README.md b/README.md index f46ffe8f..2d0d537c 100644 --- a/README.md +++ b/README.md @@ -137,7 +137,7 @@ These examples incubate dotSCAD and dotSCAD refactors these examples. See [examp - [util/bsearch](https://openhome.cc/eGossip/OpenSCAD/lib3x-bsearch.html) - [util/choose](https://openhome.cc/eGossip/OpenSCAD/lib3x-choose.html) - [util/dedup](https://openhome.cc/eGossip/OpenSCAD/lib3x-dedup.html) -- util/degrees +- [util/degrees](https://openhome.cc/eGossip/OpenSCAD/lib3x-degrees.html) - [util/every](https://openhome.cc/eGossip/OpenSCAD/lib3x-every.html) - [util/fibseq](https://openhome.cc/eGossip/OpenSCAD/lib3x-fibseq.html) - [util/flat](https://openhome.cc/eGossip/OpenSCAD/lib3x-flat.html) diff --git a/docs/lib3x-degrees.md b/docs/lib3x-degrees.md new file mode 100644 index 00000000..89037eb6 --- /dev/null +++ b/docs/lib3x-degrees.md @@ -0,0 +1,15 @@ +# degrees + +Converts a radian measurement to the corresponding value in degrees. + +**Since:**: 3.0 + +## Parameters + +- `radians` : The radians value. + +## Examples + + use ; + + assert(degrees(PI) == 180); diff --git a/src/util/degrees.scad b/src/util/degrees.scad index fe02a304..036e60ce 100644 --- a/src/util/degrees.scad +++ b/src/util/degrees.scad @@ -1 +1,11 @@ +/** +* degrees.scad +* +* @copyright Justin Lin, 2020 +* @license https://opensource.org/licenses/lgpl-3.0.html +* +* @see https://openhome.cc/eGossip/OpenSCAD/lib3x-degrees.html +* +**/ + function degrees(radians) = 180 / PI * radians; \ No newline at end of file