Commit ff63b062 authored by William Wadsworth's avatar William Wadsworth
Browse files

add docstring examples

parent 3bea955a
Loading
Loading
Loading
Loading
Loading
+15 −0
Original line number Diff line number Diff line
@@ -1188,6 +1188,11 @@ module cylinder_to_square_column(d=undef, r=undef, h=undef, transition=undef){

/* Create a cube that is rounded on top and flat on the bottom

### Example
```example
round_top_cube([25,50,8], rounding_radius=2, center=true, $fn=16);
```

:param dimensions: `[x, y, z]` dimensions of the cube
:param rounding_radius: The corner radius.
:param center: If `true` places at center in xy, but still the base is at z=0
@@ -1229,6 +1234,11 @@ module round_top_cube(dimensions, rounding_radius, center=false){

/* Create a cube with rounded edges and corners

### Example
```example
rounded_cube([25,50,8], rounding_radius=2, center=true, $fn=16);
```

:param dimensions: `[x, y, z]` dimensions of the cube
:param rounding_radius: The corner radius.
:param center: If `true` places at center in xyz
@@ -1448,6 +1458,11 @@ module two_line_text(message1="", message2="", shift_up=0, size=14, halign="cent

/* Create a cube with sloping edges at the top

### Example
```example
slope_top_cube([25,50,8], slope_angle=30, slope_depth=2, center=true);
```

:param dimensions: `[x, y, z]` dimensions of the cube
:param slope_angle: The angle above the horizontal for the slope
:param slope_depth: The distance below the top that the slope starts