Doc string for GearSettings

2018-12-27 11:29:57 +01:00 · 2018-12-27 11:29:57 +01:00 · 1739d11af5
parent d0356a12a3
commit 1739d11af5
1 changed files with 10 additions and 0 deletions
--- a/boxes/edges.py
+++ b/boxes/edges.py
@ -1874,6 +1874,16 @@ class FlexEdge(BaseEdge):

 class GearSettings(Settings):

+    """Settings for rack (and pinion) edge
+Values:
+* absolute_params
+
+ * dimension : 3.0 : modulus of the gear (in mm)
+ * angle : 20.0 : pressure angle
+ * profile_shift : 20.0 : Profile shift
+ * clearance : 0.0 : clearance
+"""
+
    absolute_params = {
        "dimension" : 3.0,
        "angle" : 20.0,