Introduce Error Codes

README.md

@@ -61,9 +61,13 @@ func ExampleLatLngToCell() {
  latLng := h3.NewLatLng(37.775938728915946, -122.41795063018799)
  resolution := 9 // between 0 (biggest cell) and 15 (smallest cell)
 
- cell := h3.LatLngToCell(latLng, resolution)
+ cell, err := h3.LatLngToCell(latLng, resolution)
+ if err != nil {
+  fmt.Printf("%s", err.Error())
+ } else {
+  fmt.Printf("%s", cell)
+ }
 
- fmt.Printf("%s", cell)
  // Output:
  // 8928308280fffff
 }

bench_test.go

@@ -10,7 +10,7 @@ var (
 		Lat: 37,
 		Lng: -122,
 	}
-	cell     = LatLngToCell(geo, 15)
+	cell, _  = LatLngToCell(geo, 15)
 	addr     = cell.String()
 	geoBndry CellBoundary
 	cells    []Cell
@@ -30,30 +30,30 @@ func BenchmarkFromString(b *testing.B) {
 
 func BenchmarkToGeoRes15(b *testing.B) {
 	for n := 0; n < b.N; n++ {
-		geo = CellToLatLng(cell)
+		geo, _ = CellToLatLng(cell)
 	}
 }
 
 func BenchmarkFromGeoRes15(b *testing.B) {
 	for n := 0; n < b.N; n++ {
-		cell = LatLngToCell(geo, 15)
+		cell, _ = LatLngToCell(geo, 15)
 	}
 }
 
 func BenchmarkToGeoBndryRes15(b *testing.B) {
 	for n := 0; n < b.N; n++ {
-		geoBndry = CellToBoundary(cell)
+		geoBndry, _ = CellToBoundary(cell)
 	}
 }
 
 func BenchmarkHexRange(b *testing.B) {
 	for n := 0; n < b.N; n++ {
-		cells = cell.GridDisk(10)
+		cells, _ = cell.GridDisk(10)
 	}
 }
 
 func BenchmarkPolyfill(b *testing.B) {
 	for n := 0; n < b.N; n++ {
-		cells = PolygonToCells(validGeoPolygonHoles, 15)
+		cells, _ = PolygonToCells(validGeoPolygonHoles, 15)
 	}
 }

example_test.go

@@ -9,8 +9,14 @@ import (
 func ExampleLatLngToCell() {
 	latLng := h3.NewLatLng(37.775938728915946, -122.41795063018799)
 	resolution := 9
-	c := h3.LatLngToCell(latLng, resolution)
-	fmt.Printf("%s", c)
+
+	cell, err := h3.LatLngToCell(latLng, resolution)
+	if err != nil {
+		fmt.Printf("%s", err.Error())
+	} else {
+		fmt.Printf("%s", cell)
+	}
+
 	// Output:
 	// 8928308280fffff
 }