Prepare for release v3.7.0 (#395)

* update changelog and fix @defgroup for exactEdgeLength

* update docs

* Changelog: Change CHANGELOG to match style of previous CHANGELOG changes

* get reeeealy specific in the release steps

Author: ajfriend

.ycm_extra_conf.py

@@ -6,17 +6,22 @@ The public API of this library consists of the functions declared in file
 [h3api.h.in](./src/h3lib/include/h3api.h.in).
 
 ## [Unreleased]
-### Added
-- area and haversine distance functions:
-    - cellAreaRads2
-    - cellAreaKm2
-    - cellAreaM2
-    - pointDistRads
-    - pointDistKm
-    - pointDistM
-    - exactEdgeLengthRads
-    - exactEdgeLengthKm
-    - exactEdgeLengthM
+
+## [3.7.0] - 2020-09-28
+### Added
+- Area and haversine distance functions (#377):
+    - `cellAreaRads2`
+    - `cellAreaKm2`
+    - `cellAreaM2`
+    - `pointDistRads`
+    - `pointDistKm`
+    - `pointDistM`
+    - `exactEdgeLengthRads`
+    - `exactEdgeLengthKm`
+    - `exactEdgeLengthM`
+- Refactor `getH3UnidirectionalEdgeBoundary` for accuracy at small resolutions. (#391)
+    - Speeds up `getH3UnidirectionalEdgeBoundary` by about 3x.
+    - Implement core logic for future vertex mode.
 ### Fixed
 - Fixed building the library with custom memory allocation functions on Mac OSX. (#362)
 - The installed H3 CMake target should have include directories specified. (#381)

CHANGELOG.md

@@ -2,8 +2,10 @@
 
 1. Create a PR "Preparing for release X.Y.Z" against master branch
     * Alter CHANGELOG.md from `[Unreleased]` to `[X.Y.Z] YYYY-MM-DD`
-    * Run `make update-version` and give `X.Y.Z` when prompted
+    * Run `make update-version` and give `X.Y.Z` when prompted (this updates
+      the VERSION file, so don't change it manually)
     * Check that all merges that need to be in the changelog are present
+    * Get reviews and merge the PR
 
 2. Create a release "Release X.Y.Z" on Github
     * Create Tag `vX.Y.Z`

RELEASE.md

@@ -1 +1 @@
-3.6.4
+3.7.0

VERSION

@@ -34,6 +34,30 @@ double hexAreaM2(int res);
 
 Average hexagon area in square meters at the given resolution.
 
+## cellAreaKm2
+
+```
+double cellAreaKm2(H3Index h);
+```
+
+Exact area of specific cell in square kilometers.
+
+## cellAreaM2
+
+```
+double cellAreaM2(H3Index h);
+```
+
+Exact area of specific cell in square meters.
+
+## cellAreaRads2
+
+```
+double cellAreaRads2(H3Index h);
+```
+
+Exact area of specific cell in square radians.
+
 ## edgeLengthKm
 
 ```
@@ -50,6 +74,31 @@ double edgeLengthM(int res);
 
 Average hexagon edge length in meters at the given resolution.
 
+
+## exactEdgeLengthKm
+
+```
+double exactEdgeLengthKm(H3Index edge);
+```
+
+Exact edge length of specific unidirectional edge in kilometers.
+
+## exactEdgeLengthM
+
+```
+double exactEdgeLengthM(H3Index edge);
+```
+
+Exact edge length of specific unidirectional edge in meters.
+
+## exactEdgeLengthRads
+
+```
+double exactEdgeLengthRads(H3Index edge);
+```
+
+Exact edge length of specific unidirectional edge in radians.
+
 ## numHexagons
 
 ```
@@ -91,3 +140,30 @@ int pentagonIndexCount();
 ```
 
 Number of pentagon **H3** indexes per resolution. This is always 12, but provided as a convenience.
+
+## pointDistKm
+
+```
+double pointDistKm(const GeoCoord *a, const GeoCoord *b);
+```
+
+Gives the "great circle" or "haversine" distance between pairs of
+GeoCoord points (lat/lng pairs) in kilometers.
+
+## pointDistM
+
+```
+double pointDistM(const GeoCoord *a, const GeoCoord *b);
+```
+
+Gives the "great circle" or "haversine" distance between pairs of
+GeoCoord points (lat/lng pairs) in meters.
+
+## pointDistRads
+
+```
+double pointDistRads(const GeoCoord *a, const GeoCoord *b);
+```
+
+Gives the "great circle" or "haversine" distance between pairs of
+GeoCoord points (lat/lng pairs) in radians.

docs/api/misc.md

@@ -301,7 +301,12 @@ double H3_EXPORT(edgeLengthKm)(int res);
 
 /** @brief average hexagon edge length in meters (excludes pentagons) */
 double H3_EXPORT(edgeLengthM)(int res);
+/** @} */
 
+/** @defgroup exactEdgeLength exactEdgeLength
+ * Functions for exactEdgeLength
+ * @{
+ */
 /** @brief exact length for a specific unidirectional edge in radians*/
 double H3_EXPORT(exactEdgeLengthRads)(H3Index edge);