doc fixes

Author: adrianVmariano

bottlecaps.scad

@@ -1204,7 +1204,7 @@ module sp_neck(diam,type,wall,id,style="L",bead=false, anchor, spin, orient)
 
     extra_bot = type==400 && bead ? -min(column(beadpts,1))+max(isect400) : 0;
     bead_shift = type==400 ? H+max(isect400) : entry[5]+W/2;  // entry[5] is L
-    
+
     attachable(anchor,spin,orient,r=bead ? beadmax : T/2, l=H+extra_bot){
         up((H+extra_bot)/2){
             difference(){

gears.scad

@@ -515,7 +515,7 @@ function _inherit_gear_thickness(thickness,dflt=10) =
 //   with self-locking systems is that if the worm gear moves a large mass and the drive is suddenly shut off, the
 //   worm wheel is still trying to move due to inertia, which can create large loads that fracture the worm.
 //   In such cases, the worm cannot be stopped abruptly but must rotate a little further (called "over travel")
-//   after switching off the drive
+//   after switching off the drive.
 // Subsection: Bevel Gears
 //   Bevel gearing is another way of dealing with intersecting gear shafts.  For bevel gears, the teeth centers lie on
 //   the surface of an imaginary cone, which is the "pitch cone" of the bevel gear.  Two bevel gears can mesh when their pitch cone
@@ -3484,7 +3484,7 @@ function _gear_tooth_profile(
 //   sun_ring = set sun/ring ratio to this value in a sun driven system, must have absolute value smaller than 1
 //   helical = create gears with specified helical angle.  Default: 0
 //   gear_spin = rotate the driven gear by this number of degrees.  Default:0
-// Example(2D,NoAxes,Anim,Frames=180,VPT=[-0.875705,-0.110537,-66.3877],VPR=[0,0,0],VPD=102,Med): In this example we request a ring/carrier ratio of 1.341 and the system produced has a ratio of 4/3.  The sun is fixed, the input is carried by the ring, and the carrier, shown as the blue triangle, is the output, rotating approximately in accordance with the requested ratio.  
+// Example(2D,NoAxes,Anim,Frames=90,FPS=30,VPT=[-0.875705,-0.110537,-66.3877],VPR=[0,0,0],VPD=102,Med): In this example we request a ring/carrier ratio of 1.341 and the system produced has a ratio of 4/3.  The sun is fixed, the input is carried by the ring, and the carrier, shown as the blue triangle, is the output, rotating approximately in accordance with the requested ratio.  
 //   mod=1;
 //   gear_data = planetary_gears(mod=mod, n=3, max_teeth=28, ring_carrier=1.341, gear_spin=4/3*360/3*$t);
 //   ring_gear2d(mod=mod, teeth=gear_data[1][1], profile_shift=gear_data[1][2], gear_spin=gear_data[1][3],backing=2);
@@ -3501,7 +3501,7 @@ function _gear_tooth_profile(
 //     spur_gear2d(mod=mod, teeth=gear_data[0][1], profile_shift=gear_data[0][2], gear_spin=gear_data[0][3]);  //sun
 //   color("red")move_copies(gear_data[2][4])
 //       spur_gear2d(mod=mod, teeth=gear_data[2][1], profile_shift=gear_data[2][2], gear_spin=gear_data[2][3][$idx]);
-// Example(3D,Med,NoAxes,Anim,Frames=5,VPT=[0.128673,0.24149,0.651451],VPR=[38.5,0,21],VPD=222.648): Here we request a sun/ring ratio of 3 and it is exactly achieved.  The carrier, shown in blue, is fixed.  This example is shown with helical gears.  It is important to remember to flip the sign of the helical angle for the planet gears.  
+// Example(3D,Med,NoAxes,Anim,Frames=7,FPS=20,VPT=[0.128673,0.24149,0.651451],VPR=[38.5,0,21],VPD=222.648): Here we request a sun/ring ratio of 3 and it is exactly achieved.  The carrier, shown in blue, is fixed.  This example is shown with helical gears.  It is important to remember to flip the sign of the helical angle for the planet gears.  
 //   mod=1;
 //   helical=25;
 //   gear_data = planetary_gears(mod=mod, n=4, max_teeth=82, sun_ring=3, helical=helical,gear_spin=360/27*$t);

skin.scad

@@ -1082,7 +1082,7 @@ module rotate_sweep(
 //   If turns is positive the path will be right-handed;  if turns is negative the path will be left-handed.
 //   Such an extrusion can be used to make screw threads.  
 //   .
-//   The lead_in options specify a lead-in setiton where the ends of the spiral scale down to avoid a sharp cut face at the ends.
+//   The lead_in options specify a lead-in section where the ends of the spiral scale down to avoid a sharp cut face at the ends.
 //   You can specify the length of this scaling directly with the lead_in parameters or as an angle using the lead_in_ang parameters.
 //   If you give a positive value, the extrusion is lengthenend by the specified distance or angle; if you give a negative
 //   value then the scaled end is included in the extrusion length specified by `turns`.  If the value is zero then no scaled ends

threading.scad

@@ -2011,7 +2011,8 @@ module _nutshape(nutwidth, h, shape, bevel1, bevel2)
 // Topics: Threading, Screws
 // See Also: generic_threaded_rod()
 // Usage:
-//   thread_helix(d, pitch, [thread_depth], [flank_angle], [turns], [profile=], [left_handed=], [higbee=], [internal=]);
+//     thread_helix(d, pitch, turns=, [thread_depth=], [thread_angle=|flank_angle=], [profile=], [starts=], [internal=], ...) {ATTACHMENTS};
+//     thread_helix(d1=,d2=, pitch=, turns=, [thread_depth=], [thread_angle=|flank_angle=], [profile=], [starts=], [internal=], ...) {ATTACHMENTS};
 // Description:
 //   Creates a right-handed helical thread with optional end tapering.  Unlike
 //   {{generic_threaded_rod()}, this module just generates the thread, and you specify the total
@@ -2036,9 +2037,12 @@ module _nutshape(nutwidth, h, shape, bevel1, bevel2)
 //   unlike the threaded_rod modules, thread_helix does not adjust the diameter for faceting, nor does it
 //   subtract any $slop for clearance.  
 //   .
-//   The taper options specify tapering at of the threads at each end, and is given as the linear distance
-//   over which to taper.  If taper is positive the threads are lengthened by the specified distance; if taper
-//   is negative, the taper is included in the thread length specified by `turns`.  Tapering works on both internal and external threads.  
+//   The lead_in options specify a lead-in section where the ends of the threads scale down to avoid a sharp face at the thread ends.
+//   You can specify the length of this scaling directly with the lead_in parameters or as an angle using the lead_in_ang parameters.
+//   If you give a positive value, the extrusion is lengthenend by the specified distance or angle; if you give a negative
+//   value then the scaled end is included in the extrusion length specified by `turns`.  If the value is zero then no scaled ends
+//   are produced.  The shape of the scaled ends can be controlled with the lead_in_shape parameter.  Supported options are "sqrt", "linear"
+//   "smooth" and "cut".  Lead-in works on both internal and external threads.
 // Figure(2D,Med,NoAxes):
 //   pa_delta = tan(15)/4;
 //      rr1 = -1/2;
@@ -2091,24 +2095,23 @@ module _nutshape(nutwidth, h, shape, bevel1, bevel2)
 //   d = Base diameter of threads.  Default: 10
 //   pitch = Distance between threads.  Default: 2
 //   ---
+//   turns = Number of revolutions to rotate thread around.
 //   thread_depth = Depth of threads from top to bottom.
 //   flank_angle = Angle of thread faces to plane perpendicular to screw.  Default: 15 degrees.
-//   turns = Number of revolutions to rotate thread around.
 //   thread_angle = Angle between two thread faces.  
 //   profile = If an asymmetrical thread profile is needed, it can be specified here.
 //   starts = The number of thread starts.  Default: 1
 //   left_handed = If true, thread has a left-handed winding.
-//   internal = if true make internal threads.  The only effect this has is to change how the threads taper if tapering is selected. When true, threads taper towards the outside; when false, they taper towards the inside.  Default: false
+//   internal = if true make internal threads.  The only effect this has is to change how the thread lead_in is constructed. When true, the lead-in section tapers towards the outside; when false, it tapers towards the inside.  Default: false
 //   d1 = Bottom inside base diameter of threads.
 //   d2 = Top inside base diameter of threads.
-//   thread_angle = Angle between 
 //   lead_in = Specify linear length of the lead in section of the threading with blunt start threads
 //   lead_in1 = Specify linear length of the lead in section of the threading at the bottom with blunt start threads
 //   lead_in2 = Specify linear length of the lead in section of the threading at the top with blunt start threads
 //   lead_in_ang = Specify angular length in degrees of the lead in section of the threading with blunt start threads
 //   lead_in_ang1 = Specify angular length in degrees of the lead in section of the threading at the bottom with blunt start threads
 //   lead_in_ang2 = Specify angular length in degrees of the lead in section of the threading at the top with blunt start threads
-//   lead_in_shape = Specify the shape of the thread lead in by giving a text string or function.  Default: "default"
+//   lead_in_shape = Specify the shape of the thread lead in by giving a text string or function.  Default: "sqrt"
 //   lead_in_sample = Factor to increase sample rate in the lead-in section.  Default: 10
 //   anchor = Translate so anchor point is at origin (0,0,0).  See [anchor](attachments.scad#subsection-anchor).  Default: `CENTER`
 //   spin = Rotate this many degrees around the Z axis after anchor.  See [spin](attachments.scad#subsection-spin).  Default: `0`