fix typos

Author: goswinr

CHANGELOG.md

@@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.11.0] - 2025-5-25
+### Changed
+- Referencing Rhino.Scripting 0.11.0
+### Added
+- build for .NET 7 too
+### Fixed
+- typos in documentation
 
 ## [0.10.2] - 2025-03-25
 ### Fixed
@@ -24,7 +31,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.8.2] - 2025-02-24
 ### Changed
 - Referencing Rhino.Scripting 0.8.0
-- rename Rhino.Scripting.FSharp -> Rhino.Scripting.FSharp (capital S)
+- rename Rhino.Scripting.Fsharp -> Rhino.Scripting.FSharp (capital S)
 
 ## [0.8.1] - 2024-10-06
 ### Changed
@@ -40,7 +47,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - First public release
 - Referencing Rhino.Scripting 0.5.0
 
-[Unreleased]: https://github.com/goswinr/Rhino.Scripting.FSharp/compare/0.10.2...HEAD
+[Unreleased]: https://github.com/goswinr/Rhino.Scripting.FSharp/compare/0.11.0...HEAD
+[0.11.0]: https://github.com/goswinr/Rhino.Scripting.FSharp/compare/0.10.2...0.11.0
 [0.10.2]: https://github.com/goswinr/Rhino.Scripting.FSharp/compare/0.10.1...0.10.2
 [0.10.1]: https://github.com/goswinr/Rhino.Scripting.FSharp/compare/0.10.0...0.10.1
 [0.10.0]: https://github.com/goswinr/Rhino.Scripting.FSharp/compare/0.8.2...0.10.0

Docs/docs.txt

@@ -1 +1 @@
-the files Readme.md is copied from the root to this docs folder as index.md via .github/workflow/docs.yml
+the file README.md is copied from the root to this docs folder as index.md via .github/workflow/docs.yml

Src/RhPoints.fs

@@ -13,7 +13,7 @@ open Rhino.Scripting
 module RhPoints =
 
 
-    /// returns the closest point index form a Point list  to a given Point
+    /// returns the closest point index from a Point list to a given Point
     let closestPointIdx (pt:Point3d) (pts:ResizeArray<Point3d>) : int =
         if pts.Count = 0 then RhinoScriptingFSharpException.Raise "RhPoints.closestPoint empty List of Points: pts"
         let mutable mi = -1
@@ -26,7 +26,7 @@ module RhPoints =
                 mi <- i
         mi
 
-    /// returns the closest point form a Point list to a given Point
+    /// returns the closest point from a Point list to a given Point
     let closestPoint (pt:Point3d) (pts:ResizeArray<Point3d>) : Point3d=
         pts.[closestPointIdx pt pts]
 
@@ -55,7 +55,7 @@ module RhPoints =
         Point3d.distance xs.[i]  ys.[j]
 
     /// find the index of the point that has the biggest distance to any point from the other set
-    /// basically the mos lonely point in 'findPointFrom' list with respect to 'checkAgainst' list
+    /// basically the most lonely point in 'findPointFrom' list with respect to 'checkAgainst' list
     /// returns findPointFromIdx * checkAgainstIdx
     let mostDistantPointIdx (findPointFrom:ResizeArray<Point3d>) (checkAgainst:ResizeArray<Point3d>) : int*int=
         if findPointFrom.Count = 0 then RhinoScriptingFSharpException.Raise "RhPoints.mostDistantPoint empty List of Points: findPointFrom"
@@ -84,7 +84,7 @@ module RhPoints =
         findPointFrom.[i]
 
 
-    /// Culls points if they are to close to previous or next item
+    /// Culls points if they are too close to previous or next item
     /// Last and first points stay the same
     let cullDuplicatePointsInSeq (tolerance) (pts:ResizeArray<Point3d>)  =
         if pts.Count = 0 then RhinoScriptingFSharpException.Raise "RhPoints.cullDuplicatePointsInSeq empty List of Points: pts"
@@ -110,7 +110,7 @@ module RhPoints =
 
 
     let internal minIndexBy (projection : 'T -> 'Key) (xs: ResizeArray<'T>) : int =
-        if xs.Count = 0 then RhinoScriptingFSharpException.Raise "RhPoints.ResizeArr.minIndexBy: Failed on empty ." // noReflection for Fable. <%O>" typeof<'T>
+        if xs.Count = 0 then RhinoScriptingFSharpException.Raise "RhPoints.ResizeArr.minIndexBy: Failed on empty." // noReflection for Fable. <%O>" typeof<'T>
         let mutable f = projection xs.[0]
         let mutable mf = f
         let mutable ii = 0
@@ -121,7 +121,7 @@ module RhPoints =
                 mf <- f
         ii
     let internal maxIndexBy (projection : 'T -> 'Key) (xs: ResizeArray<'T>) : int =
-        if xs.Count = 0 then RhinoScriptingFSharpException.Raise "RhPoints.ResizeArr.maxIndBy: Failed on empty ResizeArray." // noReflection for Fable. <%O>" typeof<'T>
+        if xs.Count = 0 then RhinoScriptingFSharpException.Raise "RhPoints.ResizeArr.maxIndexBy: Failed on empty ResizeArray." // noReflection for Fable. <%O>" typeof<'T>
         let mutable f = projection xs.[0]
         let mutable mf = f
         let mutable ii = 0
@@ -148,8 +148,8 @@ module RhPoints =
         res
 
 
-    /// Similar to Join Polylines this tries to find continuous sequences of points.
-    /// 'tolGap' is the maximum allowable gap between the start and the endpoint of to segments.
+    /// Similar to Join Polylines, this tries to find continuous sequences of points.
+    /// 'tolGap' is the maximum allowable gap between the start and the endpoint of two segments.
     /// Search starts from the segment with the most points.
     /// Both start and end point of each point list is checked for adjacency
     let findContinuousPoints (tolGap:float)  (ptss: ResizeArray<ResizeArray<Point3d>>)  =

Src/RhTopology.fs

@@ -9,15 +9,15 @@ open Rhino.Scripting.RhinoScriptingUtils
 [<RequireQualifiedAccess>]
 module RhTopology =
 
-    // The same function exist on FsEX.ResizeArray module too but with extra error checking.
+    // The same function exists on FsEX.ResizeArray module too but with extra error checking.
     // Swap the values of two given indices in ResizeArray
     let inline private swap i j (xs:ResizeArray<'T>) :unit =
         if i<>j then
             let ti = xs.[i]
             xs.[i] <- xs.[j]
             xs.[j] <- ti
 
-    // The same function exist on FsEX.ResizeArray module too but with extra error checking.
+    // The same function exists on FsEX.ResizeArray module too but with extra error checking.
     // Like ResizeArray.minIndexBy but starting to search only from a given index
     let inline private minIndexByFrom  (compareBy: 'T -> 'U)  fromIdx (xs:ResizeArray<'T>) : int =
         let mutable idx = fromIdx
@@ -30,24 +30,24 @@ module RhTopology =
         idx
 
     /// Sorts elements in place to be in a circular structure.
-    /// for each line end point it finds the next closest line start point.
+    /// For each line end point it finds the next closest line start point.
     /// (Does not check other line end points that might be closer)
     /// Line is used as an abstraction to hold start and end of arbitrary object.
     let sortToLoop(getLine: 'T -> Line) (xs:ResizeArray<'T>)  =
         for i = 0 to xs.Count - 2 do // only run till second last
             let thisLine = getLine xs.[i]
-            //  TODO could be optimized using a R-Tree for very large lists instead of minBy function
+            //  TODO could be optimized using an R-Tree for very large lists instead of minBy function
             let nextIdx = xs |> minIndexByFrom (fun c -> RhinoScriptSyntax.DistanceSquare ((getLine c).From ,  thisLine.To) ) (i+1)
             xs |> swap (i+1) nextIdx
 
-    /// Sorts elements in place  to be in a circular structure.
+    /// Sorts elements in place to be in a circular structure.
     /// For each line end it finds the next closest start point or end point.
     /// Line is used as an abstraction to hold start and end of arbitrary object.
-    /// Reverses the input in place,  where required via reverseInPlace function that takes the index of the element as parameter.
+    /// Reverses the input in place, where required via reverseInPlace function that takes the index of the element as parameter.
     let sortToLoopWithReversing (getLine: 'T -> Line) (reverseInPlace: int -> 'T -> unit) (xs:ResizeArray<'T>) : unit =
         for i = 0 to xs.Count - 2 do // only run till second last
             let thisLine = getLine xs.[i]
-            // TODO could be optimized using a R-Tree for very large lists instead of minBy function
+            // TODO could be optimized using an R-Tree for very large lists instead of minBy function
             let nextIdxSt = xs |> minIndexByFrom (fun c -> RhinoScriptSyntax.DistanceSquare ((getLine c).From ,  thisLine.To) ) (i+1)
             let nextIdxEn = xs |> minIndexByFrom (fun c -> RhinoScriptSyntax.DistanceSquare ((getLine c).To   ,  thisLine.To) ) (i+1)
             // check if closest endpoint is closer than closest start-point

Src/Rhino.Scripting/Brep.fs

@@ -83,13 +83,13 @@ module AutoOpenBrep =
         let cy = Cylinder(circ,length)
         Brep.CreateFromCylinder(cy, capBottom=true, capTop=true)
 
-    ///<summary>Creates a Brep in the Shape of a Countersunk Screw Hole , 45 degrees slope
-    ///    a caped cone and a cylinder. one closed Polysurface </summary>
+    ///<summary>Creates a Brep in the shape of a Countersunk Screw Hole, 45 degrees slope.
+    ///    A capped cone and a cylinder. One closed Polysurface.</summary>
     ///<param name="plane">(Plane) Origin is center of cone-base or head</param>
-    ///<param name="outerDiameter">(float) diameter of cone base</param>
+    ///<param name="outerDiameter">(float) Diameter of cone base</param>
     ///<param name="innerDiameter">(float) Diameter of cylinder</param>
-    ///<param name="length">(float) total length of the screw brep</param>
-    ///<returns>(Brep) Brep Geometry.</returns>
+    ///<param name="length">(float) Total length of the screw brep</param>
+    ///<returns>(Brep) Brep geometry.</returns>
     static member CreateCounterSunkScrewVolume ( plane:Plane, outerDiameter, innerDiameter, length) : Brep  =
         let r = outerDiameter*0.5
         let mutable plco = Plane(plane)
@@ -110,12 +110,12 @@ module AutoOpenBrep =
         if brep.SolidOrientation = BrepSolidOrientation.Inward then
             brep.Flip()
         brep
-    ///<summary>Transforms a planar 2D curve in XY plane to the given plane and then extrudes it with CapPlanarHoles, with option extensions at both ends.</summary>
+    ///<summary>Transforms a planar 2D curve in XY plane to the given plane and then extrudes it with CapPlanarHoles, with optional extensions at both ends.</summary>
     ///<param name="curveToExtrudeInWorldXY">(Curve) A curve in world XY plane</param>
     ///<param name="plane">(Plane) A plane with any orientation</param>
-    ///<param name="height">(float) the hight to extrude along the Z axis of plane</param>
-    ///<param name="extraHeightPerSide">(float) Optional, Default Value: <c>0.0</c> , extra extension of the extrusion on both sides </param>
-    ///<returns>(Brep) Brep Geometry.</returns>
+    ///<param name="height">(float) The height to extrude along the Z axis of plane</param>
+    ///<param name="extraHeightPerSide">(float) Optional, Default Value: <c>0.0</c>, extra extension of the extrusion on both sides</param>
+    ///<returns>(Brep) Brep geometry.</returns>
     static member CreateExtrusionAtPlane(curveToExtrudeInWorldXY:Curve, plane:Plane, height, [<OPT;DEF(0.0)>]extraHeightPerSide:float) : Brep =
         let mutable pl = Plane(plane)
         if extraHeightPerSide <> 0.0 then
@@ -134,12 +134,12 @@ module AutoOpenBrep =
     ///<summary>Subtracts trimmer from brep (= BooleanDifference),
     /// so that a single brep is returned,
     /// draws objects and zooms on them if an error occurs.</summary>
-    ///<param name="trimmer">(Brep)the volume to cut out</param>
+    ///<param name="trimmer">(Brep) The volume to cut out</param>
     ///<param name="keep">(Brep) The volume to keep</param>
-    ///<param name="subtractionLocations">(int) Optional, The amount of locations where the brep is expected to be cut
+    ///<param name="subtractionLocations">(int) Optional, The number of locations where the brep is expected to be cut
     ///  This is an optional safety check that makes it twice as slow.
-    ///  It ensures that the count of breps from  Brep.CreateBooleanIntersection is equal to subtractionLocations </param>
-    ///<returns>(Brep) Brep Geometry.</returns>
+    ///  It ensures that the count of breps from Brep.CreateBooleanIntersection is equal to subtractionLocations</param>
+    ///<returns>(Brep) Brep geometry.</returns>
     static member SubtractBrep (keep:Brep,trimmer:Brep,[<OPT;DEF(0)>]subtractionLocations:int)  :Brep =
         let draw s b = RhinoScriptSyntax.Ot.AddBrep(b)|> RhinoScriptSyntax.setLayer s
 
@@ -192,9 +192,9 @@ module AutoOpenBrep =
         brep
 
     ///<summary> Calls Mesh.CreateFromBrep, and Mesh.HealNakedEdges() to try to ensure Mesh is closed if input is closed.</summary>
-    ///<param name="brep">(Brep)the Polysurface to extract Mesh from.</param>
-    ///<param name="meshingParameters">(MeshingParameters) Optional, The Meshing parameters , if omitted the current Meshing parameters are used. </param>
-    ///<returns>((Mesh Result) Ok Mesh or Error Mesh if input brep is closed but output Mesh not. Fails if no Meshes can be extracted.</returns>
+    ///<param name="brep">(Brep) The Polysurface to extract Mesh from.</param>
+    ///<param name="meshingParameters">(MeshingParameters) Optional, The meshing parameters, if omitted the current meshing parameters are used.</param>
+    ///<returns>(Result&lt;Mesh,Mesh&gt;) Ok Mesh or Error Mesh if input brep is closed but output Mesh not. Fails if no meshes can be extracted.</returns>
     static member ExtractRenderMesh (brep:Brep,[<OPT;DEF(null:MeshingParameters)>]meshingParameters:MeshingParameters) :Result<Mesh,Mesh> =
         let meshing =
             if notNull meshingParameters then