diff --git a/CHANGELOG.md b/CHANGELOG.md index f0643b5d9..7ecfc7767 100644 --- a/CHANGELOG.md +++ b/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) diff --git a/VERSION b/VERSION index 048bc5bc2..1882577d5 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -4.0.0-rc4 +4.0.0-rc5 diff --git a/dev-docs/RFCs/v4.0.0/names_for_concepts_types_functions.md b/dev-docs/RFCs/v4.0.0/names_for_concepts_types_functions.md index a2bf31adc..742cf7258 100644 --- a/dev-docs/RFCs/v4.0.0/names_for_concepts_types_functions.md +++ b/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. diff --git a/website/docs/library/migration-3.x/functions.md b/website/docs/library/migration-3.x/functions.md index 9231647c2..f4a48c85c 100644 --- a/website/docs/library/migration-3.x/functions.md +++ b/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.