Release v4.0.0-rc5 (#640)

Author: isaacbrodsky

CHANGELOG.md

@@ -6,6 +6,11 @@ The public API of this library consists of the functions declared in file
 [h3api.h.in](./src/h3lib/include/h3api.h.in).
 
 ## [Unreleased]
+
+## [4.0.0-rc5] - 2022-08-16
+### Breaking changes
+- `exactEdgeLength` functions renamed to `edgeLength` (#639)
+
 ### Fixed
 - `polygonToCells` returns an error if Infinity is passed in. (#636)
 

VERSION

@@ -1 +1 @@
-4.0.0-rc4
+4.0.0-rc5

dev-docs/RFCs/v4.0.0/names_for_concepts_types_functions.md

@@ -243,16 +243,22 @@ For a future undirected edge mode, use the term `Edge`.
 
 ### Area/Length Functions
 
-|  Current name  |        Proposed name        |
-|----------------|-----------------------------|
-| `hexAreaKm2`   | `getHexagonAreaAvgKm2`      |
-| `hexAreaM2`    | `getHexagonAreaAvgM2`       |
-| `edgeLengthKm` | `getHexagonEdgeLengthAvgKm` |
-| `edgeLengthM`  | `getHexagonEdgeLengthAvgM`  |
-| *DNE*          | `getPentagonAreaAvg*`       |
-| *DNE*          | `getPentagonEdgeLengthAvg*` |
-| *DNE*          | `cellAreaKm2`               |
-| *DNE*          | `cellAreaM2`                |
+|    3.x name.          |         4.0.0 name          |
+|-----------------------|-----------------------------|
+| `hexAreaKm2`          | `getHexagonAreaAvgKm2`      |
+| `hexAreaM2`           | `getHexagonAreaAvgM2`       |
+| `edgeLengthKm`        | `getHexagonEdgeLengthAvgKm` |
+| `edgeLengthM`         | `getHexagonEdgeLengthAvgM`  |
+| *DNE*                 | `getPentagonAreaAvg*`       |
+| *DNE*                 | `getPentagonEdgeLengthAvg*` |
+| *DNE*                 | `cellAreaKm2`               |
+| *DNE*                 | `cellAreaM2`                |
+| `pointDistKm`         | `greatCircleDistanceKm`     |
+| `pointDistM`          | `greatCircleDistanceM`      |
+| `pointDistRads`       | `greatCircleDistanceRads`   |
+| `exactEdgeLengthRads` | `edgeLengthRads`            |
+| `exactEdgeLengthKm`   | `edgeLengthKm`              |
+| `exactEdgeLengthM`    | `edgeLengthM`               |
 
 **Note**: `cellAreaKm2` and `cellAreaM2` would return the actual area of
 the passed-in cell.

website/docs/library/migration-3.x/functions.md

@@ -123,19 +123,22 @@ For a future undirected edge mode, use the term `Edge`.
 
 ### Area/Length Functions
 
-|    3.x name.    |         4.0.0 name          |
-|-----------------|-----------------------------|
-| `hexAreaKm2`    | `getHexagonAreaAvgKm2`      |
-| `hexAreaM2`     | `getHexagonAreaAvgM2`       |
-| `edgeLengthKm`  | `getHexagonEdgeLengthAvgKm` |
-| `edgeLengthM`   | `getHexagonEdgeLengthAvgM`  |
-| *DNE*           | `getPentagonAreaAvg*`       |
-| *DNE*           | `getPentagonEdgeLengthAvg*` |
-| *DNE*           | `cellAreaKm2`               |
-| *DNE*           | `cellAreaM2`                |
-| `pointDistKm`   | `greatCircleDistanceKm`     |
-| `pointDistM`    | `greatCircleDistanceM`      |
-| `pointDistRads` | `greatCircleDistanceRads`   |
+|    3.x name.          |         4.0.0 name          |
+|-----------------------|-----------------------------|
+| `hexAreaKm2`          | `getHexagonAreaAvgKm2`      |
+| `hexAreaM2`           | `getHexagonAreaAvgM2`       |
+| `edgeLengthKm`        | `getHexagonEdgeLengthAvgKm` |
+| `edgeLengthM`         | `getHexagonEdgeLengthAvgM`  |
+| *DNE*                 | `getPentagonAreaAvg*`       |
+| *DNE*                 | `getPentagonEdgeLengthAvg*` |
+| *DNE*                 | `cellAreaKm2`               |
+| *DNE*                 | `cellAreaM2`                |
+| `pointDistKm`         | `greatCircleDistanceKm`     |
+| `pointDistM`          | `greatCircleDistanceM`      |
+| `pointDistRads`       | `greatCircleDistanceRads`   |
+| `exactEdgeLengthRads` | `edgeLengthRads`            |
+| `exactEdgeLengthKm`   | `edgeLengthKm`              |
+| `exactEdgeLengthM`    | `edgeLengthM`               |
 
 **Note**: `cellAreaKm2` and `cellAreaM2` would return the actual area of
 the passed-in cell.