Skip to content

Commit 81cd79f

Browse files
committed
chore: update changelog + update migration url
1 parent 85023b1 commit 81cd79f

File tree

2 files changed

+22
-11
lines changed

2 files changed

+22
-11
lines changed

CHANGELOG.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
# Changelog
2+
23
All notable changes to this project will be documented in this file. The
34
format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
45

5-
This project tracks the **major** and **minor** versions set by
6+
This project tracks the **major** and **minor** versions set upstream by
67
[`h3`](github.com/uber/h3), and introduces backwards-compatible updates and/or
78
fixes via **patches** with patch version bumps.
89

10+
## 4.0.0
11+
12+
All new functions to match H3 v4.
13+
14+
See <https://h3geo.org/docs/library/migrating-3.x> for upstream changes, and the
15+
[README.md](./README.md) for upstream to h3-go binding name mapping.
16+
917
## 3.7.1
1018

1119
### Added
@@ -44,9 +52,11 @@ fixes via **patches** with patch version bumps.
4452
## 3.0.2
4553

4654
### Fixed
55+
4756
* `go mod vendor` now works correctly (#30, #32)
4857

4958
### Added
59+
5060
* Some useful H3 constants (#22):
5161
* `MaxResolution`
5262
* `NumIcosaFaces`

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Check out [v3](https://github.com/uber/h3-go/tree/v3.7.1) or checkout the git ta
2020

2121
**Migrating from v3?**
2222

23-
Check out [v3 to v4 migration guide](https://h3geo.org/docs/next/library/migrating-3.x/).
23+
Check out [v3 to v4 migration guide](https://h3geo.org/docs/library/migrating-3.x).
2424
There have been no breaking changes to the format of H3 indexes. Indexes
2525
generated by older versions can be parsed in v4, and vice-versa.
2626

@@ -39,7 +39,7 @@ be built. Go should do the right thing when including this library:
3939
> implies the "cgo" build constraint, as though the file also said "// +build
4040
> cgo". Therefore, if cgo is disabled, files that import "C" will not be built by
4141
> the go tool. (For more about build constraints see
42-
> https://golang.org/pkg/go/build/#hdr-Build_Constraints).
42+
> <https://golang.org/pkg/go/build/#hdr-Build_Constraints>).
4343
4444
If you see errors/warnings like _"build constraints exclude all Go files..."_,
4545
then the `cgo` build constraint is likely disabled; try setting `CGO_ENABLED=1`
@@ -57,21 +57,22 @@ go get github.com/uber/h3-go/v4
5757
import "github.com/uber/h3-go/v4"
5858

5959
func ExampleLatLngToCell() {
60-
latLng := h3.NewLatLng(37.775938728915946, -122.41795063018799)
61-
resolution := 9 // between 0 (biggest cell) and 15 (smallest cell)
60+
latLng := h3.NewLatLng(37.775938728915946, -122.41795063018799)
61+
resolution := 9 // between 0 (biggest cell) and 15 (smallest cell)
6262

63-
cell := h3.LatLngToCell(latLng, resolution)
63+
cell := h3.LatLngToCell(latLng, resolution)
6464

65-
fmt.Printf("%s", cell)
66-
// Output:
67-
// 8928308280fffff
65+
fmt.Printf("%s", cell)
66+
// Output:
67+
// 8928308280fffff
6868
}
6969

7070
```
7171

72-
# C API
72+
# C API
7373

7474
## Notes
75+
7576
* `LatLng` returns `Lat` and `Lng` as degrees, instead of radians.
7677
* H3 C API function prefixes of `get` have been dropped in support of Golang's
7778
`Getter` [naming style](https://golang.org/doc/effective_go.html#Getters).
@@ -96,7 +97,7 @@ func ExampleLatLngToCell() {
9697
| `getHexagonAreaAvg` | `HexagonAreaAvg* (3/3)` |
9798
| `cellArea` | `CellArea* (3/3)` |
9899
| `getHexagonEdgeLengthAvg` | `HexagonEdgeLengthAvg* (2/2)` |
99-
| `exactEdgeLength` | `ExactEdgeLength* (3/3)` |
100+
| `exactEdgeLength` | `EdgeLength* (3/3)` |
100101
| `getNumCells` | `NumCells` |
101102
| `getRes0Cells` | `Res0Cells` |
102103
| `getPentagons` | `Pentagons` |

0 commit comments

Comments
 (0)