Merge branch 'master' into master

Author: luc-tielen

CONTRIBUTING.md

@@ -212,14 +212,14 @@ Before release:
 
 Run the following release commands, replacing `7.0.0` with your version number:
 
-- create a release branch, replacing `xx` with your initials to make it clear who created the branch.
-  - `git checkout origin/master -b xx/release-7.0.0`
+- create a release branch and switch to it. All building, tagging and publishing will be done on the release branch, and then merged back into master in a later step.
+  - `git checkout origin/master -b release-7.0.0`
 
 - increment the version number of all packages, and create a local commit, without pushing to origin.  This will also create a release tag.
   - `pnpm lerna version --no-commit-hooks --no-push 7.0.0`
 
 - Push the release branch and the release tag.
-  - `git push origin xx/release-7.0.0 --follow-tags`
+  - `git push origin release-7.0.0 --follow-tags`
   - Pushing the tag will trigger the Github [release](https://github.com/Turfjs/turf/blob/master/.github/workflows/release.yml) action which you can view the status of at - https://github.com/Turfjs/turf/actions.  If successful, a new [version](https://www.npmjs.com/package/@turf/turf?activeTab=versions) of all turf packages will have been published on NPM.
 
 - If the release action was not successful
@@ -228,16 +228,17 @@ Run the following release commands, replacing `7.0.0` with your version number:
   - Then reset by deleting your tag and branch locally and remotely.
     - `git push --delete origin v7.1.0`
     - `git tag --delete v7.1.0`
-    - `git push -d origin xx/release-7.0.0`
-    - `git branch -d xx/release-7.0.0`
+    - `git push -d origin release-7.0.0`
+    - `git branch -d release-7.0.0`
   - Now redo the steps above starting with creating "A clean local copy of the Turf Github repository"
 
-- If the release action was successful, now create a Pull Request for the release to update master.
+- If the release action was successful, now create a Pull Request for the release to merge back to master.
   - You may be given a link in the output of the branch/tag push command to create the PR.
   - If you don't get this message, just go to https://github.com/Turfjs/turf/pulls and you should be prompted at the top to create a PR for this new branch you just pushed.
   - If that prompt doesn't appear, then just create a new pull request from the PR page and make sure the title is the version number e.g. `v7.0.0` and that it is merging your release branch -> to master.
   - Here is an example PR - https://github.com/Turfjs/turf/pull/2615.
-  - Get approval for the release PR and merge it!
+  - Get approval for the release PR, then "Squash and merge" it.
+    - Do not delete this branch in Github after merging, the release tag points to it.  If you do, click "Restore branch" at the bottom of the merged PR.
 
 #### Follow-on steps
 - As part of the release action, a draft Github release will have been created at https://github.com/Turfjs/turf/releases with an auto-generated changelog.

documentation.yml

@@ -1,165 +1,166 @@
 toc:
-  - name: Measurement
-  - along
-  - area
-  - bbox
-  - bboxPolygon
-  - bearing
-  - center
-  - centerOfMass
-  - centroid
-  - destination
-  - distance
-  - envelope
-  - length
-  - midpoint
-  - pointOnFeature
-  - polygonTangents
-  - pointToLineDistance
-  - rhumbBearing
-  - rhumbDestination
-  - rhumbDistance
-  - square
-  - greatCircle
-  - name: Coordinate Mutation
-  - cleanCoords
-  - flip
-  - rewind
-  - round
-  - truncate
-  - name: Transformation
-  - bboxClip
-  - bezierSpline
-  - buffer
-  - circle
-  - clone
-  - concave
-  - convex
-  - difference
-  - dissolve
-  - intersect
-  - lineOffset
-  - polygonSmooth
-  - simplify
-  - tesselate
-  - transformRotate
-  - transformTranslate
-  - transformScale
-  - union
-  - voronoi
-  - name: Feature Conversion
-  - combine
-  - explode
-  - flatten
-  - lineToPolygon
-  - polygonize
-  - polygonToLine
-  - name: Misc
-  - kinks
-  - lineArc
-  - lineChunk
-  - lineIntersect
-  - lineOverlap
-  - lineSegment
-  - lineSlice
-  - lineSliceAlong
-  - lineSplit
-  - mask
-  - nearestPointOnLine
-  - sector
-  - shortestPath
-  - unkinkPolygon
-  - name: Helper
-  - featureCollection
-  - feature
-  - geometryCollection
-  - lineString
-  - multiLineString
-  - multiPoint
-  - multiPolygon
-  - point
-  - polygon
-  - name: Random
-  - randomPosition
-  - randomPoint
-  - randomLineString
-  - randomPolygon
-  - name: Data
-  - sample
-  - name: Interpolation
-  - interpolate
-  - isobands
-  - isolines
-  - planepoint
-  - tin
-  - name: Joins
-  - pointsWithinPolygon
-  - tag
-  - name: Grids
-  - hexGrid
-  - pointGrid
-  - squareGrid
-  - triangleGrid
-  - name: Classification
-  - nearestPoint
-  - name: Aggregation
-  - collect
-  - clustersDbscan
-  - clustersKmeans
-  - name: Meta
-  - coordAll
-  - coordEach
-  - coordReduce
-  - featureEach
-  - featureReduce
-  - flattenEach
-  - flattenReduce
-  - getCoord
-  - getCoords
-  - getGeom
-  - getType
-  - geomEach
-  - geomReduce
-  - propEach
-  - propReduce
-  - segmentEach
-  - segmentReduce
-  - getCluster
-  - clusterEach
-  - clusterReduce
-  - name: Assertions
-  - collectionOf
-  - containsNumber
-  - geojsonType
-  - featureOf
-  - name: Booleans
-  - booleanClockwise
-  - booleanConcave
-  - booleanContains
-  - booleanCrosses
-  - booleanDisjoint
-  - booleanEqual
-  - booleanIntersects
-  - booleanOverlap
-  - booleanParallel
-  - booleanPointInPolygon
-  - booleanPointOnLine
-  - booleanTouches
-  - booleanWithin
-  - name: Unit Conversion
-  - bearingToAzimuth
-  - azimuthToBearing
-  - convertArea
-  - convertLength
-  - degreesToRadians
-  - lengthToRadians
-  - lengthToDegrees
-  - radiansToLength
-  - radiansToDegrees
-  - toMercator
-  - toWgs84
+  Measurement:
+    - along
+    - area
+    - bbox
+    - bboxPolygon
+    - bearing
+    - center
+    - centerOfMass
+    - centroid
+    - destination
+    - distance
+    - envelope
+    - length
+    - midpoint
+    - pointOnFeature
+    - polygonTangents
+    - pointToLineDistance
+    - rhumbBearing
+    - rhumbDestination
+    - rhumbDistance
+    - square
+    - greatCircle
+  Coordinate Mutation:
+    - cleanCoords
+    - flip
+    - rewind
+    - round
+    - truncate
+  Transformation:
+    - bboxClip
+    - bezierSpline
+    - buffer
+    - circle
+    - clone
+    - concave
+    - convex
+    - difference
+    - dissolve
+    - intersect
+    - lineOffset
+    - polygonSmooth
+    - simplify
+    - tesselate
+    - transformRotate
+    - transformTranslate
+    - transformScale
+    - union
+    - voronoi
+  Feature Conversion:
+    - combine
+    - explode
+    - flatten
+    - lineToPolygon
+    - polygonize
+    - polygonToLine
+  Misc:
+    - kinks
+    - lineArc
+    - lineChunk
+    - lineIntersect
+    - lineOverlap
+    - lineSegment
+    - lineSlice
+    - lineSliceAlong
+    - lineSplit
+    - mask
+    - nearestPointOnLine
+    - sector
+    - shortestPath
+    - unkinkPolygon
+  Helper:
+    - featureCollection
+    - feature
+    - geometryCollection
+    - lineString
+    - multiLineString
+    - multiPoint
+    - multiPolygon
+    - point
+    - polygon
+  Random:
+    - randomPosition
+    - randomPoint
+    - randomLineString
+    - randomPolygon
+  Data:
+    - sample
+  Interpolation:
+    - interpolate
+    - isobands
+    - isolines
+    - planepoint
+    - tin
+  Joins:
+    - pointsWithinPolygon
+    - tag
+  Grids:
+    - hexGrid
+    - pointGrid
+    - squareGrid
+    - triangleGrid
+  Classification:
+    - nearestPoint
+  Aggregation:
+    - collect
+    - clustersDbscan
+    - clustersKmeans
+  Meta:
+    - coordAll
+    - coordEach
+    - coordReduce
+    - featureEach
+    - featureReduce
+    - flattenEach
+    - flattenReduce
+    - getCoord
+    - getCoords
+    - getGeom
+    - getType
+    - geomEach
+    - geomReduce
+    - propEach
+    - propReduce
+    - segmentEach
+    - segmentReduce
+    - getCluster
+    - clusterEach
+    - clusterReduce
+  Assertions:
+    - collectionOf
+    - containsNumber
+    - geojsonType
+    - featureOf
+  Booleans:
+    - booleanClockwise
+    - booleanConcave
+    - booleanContains
+    - booleanCrosses
+    - booleanDisjoint
+    - booleanEqual
+    - booleanIntersects
+    - booleanOverlap
+    - booleanParallel
+    - booleanPointInPolygon
+    - booleanPointOnLine
+    - booleanTouches
+    - booleanWithin
+  Unit Conversion:
+    - bearingToAzimuth
+    - azimuthToBearing
+    - convertArea
+    - convertLength
+    - degreesToRadians
+    - lengthToRadians
+    - lengthToDegrees
+    - radiansToLength
+    - radiansToDegrees
+    - toMercator
+    - toWgs84
 paths:
   GeoJSON: "https://tools.ietf.org/html/rfc7946#section-3"
+  GeoJsonProperties: "https://tools.ietf.org/html/rfc7946#section-3.2"
   GeometryCollection: "https://tools.ietf.org/html/rfc7946#section-3.1.8"
   Point: "https://tools.ietf.org/html/rfc7946#section-3.1.2"
   Points: "https://tools.ietf.org/html/rfc7946#section-3.1.2"

packages/turf-along/README.md

@@ -8,11 +8,11 @@ Takes a [LineString][1] and returns a [Point][2] at a specified distance along t
 
 ### Parameters
 
-*   `line` **[Feature][3]<[LineString][1]>** input line
+*   `line` **([Feature][3]<[LineString][1]> | [LineString][1])** input line
 *   `distance` **[number][4]** distance along the line
-*   `options` **[Object][5]?** Optional parameters
+*   `options` **[Object][5]?** Optional parameters (optional, default `{}`)
 
-    *   `options.units` **[string][6]** can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`)
+    *   `options.units` **Units** can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`)
 
 ### Examples
 
@@ -38,8 +38,6 @@ Returns **[Feature][3]<[Point][2]>** Point `distance` `units` along the line
 
 [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
 <!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 
 ---