Skip to content

Commit

Permalink
Result of running yarn docs from the project root with the previously…
Browse files Browse the repository at this point in the history 
… committed changes.
  • Loading branch information
@smallsaucepan
smallsaucepan committed Nov 3, 2023
1 parent a9b65d2 commit 4269431
Show file tree
Hide file tree
Showing 112 changed files with 944 additions and 1,705 deletions.
33 changes: 12 additions & 21 deletions packages/turf-along/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Takes a [LineString][1] and returns a [Point][2] at a specified distance along t

### Parameters

* `line` **[Feature][3]<[LineString][4]>** input line
* `distance` **[number][5]** distance along the line
* `options` **[Object][6]?** Optional parameters
* `line` **[Feature][3]<[LineString][1]>** input line
* `distance` **[number][4]** distance along the line
* `options` **[Object][5]?** Optional parameters

* `options.units` **[string][7]** can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`)
* `options.units` **[string][6]** can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`)

### Examples

Expand All @@ -26,44 +26,35 @@ var along = turf.along(line, 200, options);
var addToMap = [along, line]
```

Returns **[Feature][3]<[Point][8]>** Point `distance` `units` along the line
Returns **[Feature][3]<[Point][2]>** Point `distance` `units` along the line

[1]: https://tools.ietf.org/html/rfc7946#section-3.1.4

[2]: https://tools.ietf.org/html/rfc7946#section-3.1.2

[3]: https://tools.ietf.org/html/rfc7946#section-3.2

[4]: https://tools.ietf.org/html/rfc7946#section-3.1.4
[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

[8]: https://tools.ietf.org/html/rfc7946#section-3.1.2

<!-- This file is automatically generated. Please don't edit it directly:
if you find an error, edit the source file (likely index.js), and re-run
./scripts/generate-readmes in the turf project. -->
<!-- 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. -->

---

This module is part of the [Turfjs project](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.
This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.

### Installation

Install this module individually:
Install this single module individually:

```sh
$ npm install @turf/along
```

Or install the Turf module that includes it as a function:
Or install the all-encompassing @turf/turf module that includes all modules as functions:

```sh
$ npm install @turf/turf
Expand Down
13 changes: 4 additions & 9 deletions packages/turf-angle/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,26 +34,21 @@ Returns **[number][4]** Angle between the provided points, or its explementary.

[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

<!-- This file is automatically generated. Please don't edit it directly:
if you find an error, edit the source file (likely index.js), and re-run
./scripts/generate-readmes in the turf project. -->
<!-- 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. -->

---

This module is part of the [Turfjs project](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.
This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.

### Installation

Install this module individually:
Install this single module individually:

```sh
$ npm install @turf/angle
```

Or install the Turf module that includes it as a function:
Or install the all-encompassing @turf/turf module that includes all modules as functions:

```sh
$ npm install @turf/turf
Expand Down
13 changes: 4 additions & 9 deletions packages/turf-area/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,26 +28,21 @@ Returns **[number][2]** area in square meters

[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

<!-- This file is automatically generated. Please don't edit it directly:
if you find an error, edit the source file (likely index.js), and re-run
./scripts/generate-readmes in the turf project. -->
<!-- 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. -->

---

This module is part of the [Turfjs project](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.
This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.

### Installation

Install this module individually:
Install this single module individually:

```sh
$ npm install @turf/area
```

Or install the Turf module that includes it as a function:
Or install the all-encompassing @turf/turf module that includes all modules as functions:

```sh
$ npm install @turf/turf
Expand Down
31 changes: 12 additions & 19 deletions packages/turf-bbox-clip/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ May result in degenerate edges when clipping Polygons.

### Parameters

* `feature` **[Feature][3]<([LineString][4] | [MultiLineString][5] | [Polygon][6] | [MultiPolygon][7])>** feature to clip to the bbox
* `bbox` **[BBox][8]** extent in \[minX, minY, maxX, maxY] order
* `feature` **[Feature][1]<([LineString][3] | [MultiLineString][4] | [Polygon][5] | [MultiPolygon][6])>** feature to clip to the bbox
* `bbox` **[BBox][7]** extent in \[minX, minY, maxX, maxY] order

### Examples

Expand All @@ -25,44 +25,37 @@ var clipped = turf.bboxClip(poly, bbox);
var addToMap = [bbox, poly, clipped]
```

Returns **[Feature][3]<([LineString][4] | [MultiLineString][5] | [Polygon][6] | [MultiPolygon][7])>** clipped Feature
Returns **[Feature][1]<([LineString][3] | [MultiLineString][4] | [Polygon][5] | [MultiPolygon][6])>** clipped Feature

[1]: https://tools.ietf.org/html/rfc7946#section-3.2

[2]: https://github.com/mapbox/lineclip

[3]: https://tools.ietf.org/html/rfc7946#section-3.2
[3]: https://tools.ietf.org/html/rfc7946#section-3.1.4

[4]: https://tools.ietf.org/html/rfc7946#section-3.1.4
[4]: https://tools.ietf.org/html/rfc7946#section-3.1.5

[5]: https://tools.ietf.org/html/rfc7946#section-3.1.5
[5]: https://tools.ietf.org/html/rfc7946#section-3.1.6

[6]: https://tools.ietf.org/html/rfc7946#section-3.1.6
[6]: https://tools.ietf.org/html/rfc7946#section-3.1.7

[7]: https://tools.ietf.org/html/rfc7946#section-3.1.7
[7]: https://tools.ietf.org/html/rfc7946#section-5

[8]: https://tools.ietf.org/html/rfc7946#section-5

<!-- This file is automatically generated. Please don't edit it directly:
if you find an error, edit the source file (likely index.js), and re-run
./scripts/generate-readmes in the turf project. -->
<!-- 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. -->

---

This module is part of the [Turfjs project](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.
This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.

### Installation

Install this module individually:
Install this single module individually:

```sh
$ npm install @turf/bbox-clip
```

Or install the Turf module that includes it as a function:
Or install the all-encompassing @turf/turf module that includes all modules as functions:

```sh
$ npm install @turf/turf
Expand Down
17 changes: 5 additions & 12 deletions packages/turf-bbox-polygon/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ var poly = turf.bboxPolygon(bbox);
var addToMap = [poly]
```

Returns **[Feature][6]<[Polygon][7]>** a Polygon representation of the bounding box
Returns **[Feature][6]<[Polygon][1]>** a Polygon representation of the bounding box

[1]: https://tools.ietf.org/html/rfc7946#section-3.1.6

Expand All @@ -39,28 +39,21 @@ Returns **[Feature][6]<[Polygon][7]>** a Polygon representation of the bounding

[6]: https://tools.ietf.org/html/rfc7946#section-3.2

[7]: https://tools.ietf.org/html/rfc7946#section-3.1.6

<!-- This file is automatically generated. Please don't edit it directly:
if you find an error, edit the source file (likely index.js), and re-run
./scripts/generate-readmes in the turf project. -->
<!-- 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. -->

---

This module is part of the [Turfjs project](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.
This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.

### Installation

Install this module individually:
Install this single module individually:

```sh
$ npm install @turf/bbox-polygon
```

Or install the Turf module that includes it as a function:
Or install the all-encompassing @turf/turf module that includes all modules as functions:

```sh
$ npm install @turf/turf
Expand Down
13 changes: 4 additions & 9 deletions packages/turf-bbox/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,26 +35,21 @@ Returns **[BBox][4]** bbox extent in \[minX, minY, maxX, maxY] order

[4]: https://tools.ietf.org/html/rfc7946#section-5

<!-- This file is automatically generated. Please don't edit it directly:
if you find an error, edit the source file (likely index.js), and re-run
./scripts/generate-readmes in the turf project. -->
<!-- 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. -->

---

This module is part of the [Turfjs project](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.
This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.

### Installation

Install this module individually:
Install this single module individually:

```sh
$ npm install @turf/bbox
```

Or install the Turf module that includes it as a function:
Or install the all-encompassing @turf/turf module that includes all modules as functions:

```sh
$ npm install @turf/turf
Expand Down
13 changes: 4 additions & 9 deletions packages/turf-bearing/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,26 +42,21 @@ Returns **[number][5]** bearing in decimal degrees, between -180 and 180 degrees

[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

<!-- This file is automatically generated. Please don't edit it directly:
if you find an error, edit the source file (likely index.js), and re-run
./scripts/generate-readmes in the turf project. -->
<!-- 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. -->

---

This module is part of the [Turfjs project](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.
This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.

### Installation

Install this module individually:
Install this single module individually:

```sh
$ npm install @turf/bearing
```

Or install the Turf module that includes it as a function:
Or install the all-encompassing @turf/turf module that includes all modules as functions:

```sh
$ npm install @turf/turf
Expand Down
31 changes: 12 additions & 19 deletions packages/turf-bezier-spline/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ The bezier spline implementation is by [Leszek Rybicki][3].

### Parameters

* `line` **[Feature][4]<[LineString][5]>** input LineString
* `options` **[Object][6]** Optional parameters (optional, default `{}`)
* `line` **[Feature][4]<[LineString][1]>** input LineString
* `options` **[Object][5]** Optional parameters (optional, default `{}`)

* `options.properties` **[Object][6]** Translate properties to output (optional, default `{}`)
* `options.resolution` **[number][7]** time in milliseconds between points (optional, default `10000`)
* `options.sharpness` **[number][7]** a measure of how curvy the path should be between splines (optional, default `0.85`)
* `options.properties` **[Object][5]** Translate properties to output (optional, default `{}`)
* `options.resolution` **[number][6]** time in milliseconds between points (optional, default `10000`)
* `options.sharpness` **[number][6]** a measure of how curvy the path should be between splines (optional, default `0.85`)

### Examples

Expand All @@ -38,7 +38,7 @@ var addToMap = [line, curved]
curved.properties = { stroke: '#0F0' };
```

Returns **[Feature][4]<[LineString][5]>** curved line
Returns **[Feature][4]<[LineString][1]>** curved line

[1]: https://tools.ietf.org/html/rfc7946#section-3.1.4

Expand All @@ -48,32 +48,25 @@ Returns **[Feature][4]<[LineString][5]>** curved line

[4]: https://tools.ietf.org/html/rfc7946#section-3.2

[5]: https://tools.ietf.org/html/rfc7946#section-3.1.4
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

<!-- This file is automatically generated. Please don't edit it directly:
if you find an error, edit the source file (likely index.js), and re-run
./scripts/generate-readmes in the turf project. -->
<!-- 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. -->

---

This module is part of the [Turfjs project](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.
This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.

### Installation

Install this module individually:
Install this single module individually:

```sh
$ npm install @turf/bezier-spline
```

Or install the Turf module that includes it as a function:
Or install the all-encompassing @turf/turf module that includes all modules as functions:

```sh
$ npm install @turf/turf
Expand Down
13 changes: 4 additions & 9 deletions packages/turf-boolean-clockwise/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,26 +34,21 @@ Returns **[boolean][5]** true/false

[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean

<!-- This file is automatically generated. Please don't edit it directly:
if you find an error, edit the source file (likely index.js), and re-run
./scripts/generate-readmes in the turf project. -->
<!-- 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. -->

---

This module is part of the [Turfjs project](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.
This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.

### Installation

Install this module individually:
Install this single module individually:

```sh
$ npm install @turf/boolean-clockwise
```

Or install the Turf module that includes it as a function:
Or install the all-encompassing @turf/turf module that includes all modules as functions:

```sh
$ npm install @turf/turf
Expand Down
Loading

0 comments on commit 4269431

Please sign in to comment.