[general] General Fixes for Spelling and Formatting.

Author: gdey

README.md

@@ -11,7 +11,7 @@ Tegola is a vector tile server delivering [Mapbox Vector Tiles](https://github.c
 ## Features
 - Native geometry processing (simplification, clipping, make valid, intersection, contains, scaling, translation)
 - [Mapbox Vector Tile v2 specification](https://github.com/mapbox/vector-tile-spec) compliant.
-- Embedded viewer with auto generated style for quick data visualization and inspection.
+- An embedded viewer with an automatically generated style for quick data visualization and inspection.
 - Support for [PostGIS](provider/postgis) and [GeoPackage](provider/gpkg) data providers. Extensible design to support additional data providers.
 - Support for several cache backends: [file](cache/file), [s3](cache/s3), [redis](cache/redis), [azure blob store](cache/azblob).
 - Cache seeding and invalidation via individual tiles (ZXY), lat / lon bounds and ZXY tile list.
@@ -45,7 +45,7 @@ Use "tegola [command] --help" for more information about a command.
 
 ## Running tegola as a vector tile server
 1. Download the appropriate binary of tegola for your platform via the [release page](https://github.com/go-spatial/tegola/releases).
-2. Setup your config file and run. Dy default tegola looks for a `config.toml` in the same directory as the binary. You can set a different location for the `config.toml` using a command flag:
+2. Set up your config file and run. By default, Tegola looks for a `config.toml` in the same directory as the binary. You can set a different location for the `config.toml` using a command flag:
 
 ```
 ./tegola serve --config=/path/to/config.toml
@@ -57,7 +57,7 @@ Use "tegola [command] --help" for more information about a command.
 /
 ```
 
-The server root will display a built in viewer with an auto generated style. For example:
+The server root will display the built-in viewer with an automatically generated style. For example:
 
 ![tegola built in viewer](https://raw.githubusercontent.com/go-spatial/tegola/v0.4.0/docs/screenshots/built-in-viewer.png "tegola built in viewer")
 
@@ -196,7 +196,7 @@ name = "zoning"                              # used in the URL to reference this
 
 \* more on PostgreSQL SSL mode [here](https://www.postgresql.org/docs/9.2/static/libpq-ssl.html). The `postgis` config also supports "ssl_cert" and "ssl_key" options are required, corresponding semantically with "PGSSLKEY" and "PGSSLCERT". These options do not check for environment variables automatically. See the section [below](#environment-variables) on injecting environment variables into the config.
 
-### Example config using Postres 12 / PostGIS 3.0 ST_AsMVT():
+### Example config using Postgres 12 / PostGIS 3.0 ST_AsMVT():
 
 ```toml
 # register a MVT data provider. MVT data providers have the prefix "mvt_" in their type
@@ -253,10 +253,10 @@ max_connections = "${POSTGIS_MAX_CONN}"
 
 The following environment variables can be used for debugging:
 
-`TEGOLA_SQL_DEBUG` specify the type of SQL debug information to output. Currently support two values:
+`TEGOLA_SQL_DEBUG` specify the type of SQL debug information to output. Currently, supporting two values:
 
-- `LAYER_SQL`: print layer SQL as they are parsed from the config file.
-- `EXECUTE_SQL`: print SQL that is executed for each tile request and the number of items it returns or an error.
+- `LAYER_SQL` will print layer SQL as they are parsed from the config file.
+- `EXECUTE_SQL` will print SQL that is executed for each tile request, and the number of items it returns or an error.
 
 #### Usage
 
@@ -273,27 +273,27 @@ The following environment variables can be used to control various runtime optio
 
 ## Client side debugging
 
-When debugging client side, it's often helpful to to see an outline of a tile along with it's Z/X/Y values. To encode a debug layer into every tile add the query string variable `debug=true` to the URL template being used to request tiles. For example:
+When debugging client side, it's often helpful to see an outline of a tile along with it's Z/X/Y values. To encode a debug layer into every tile add the query string variable `debug=true` to the URL template being used to request tiles. For example:
 
 ```
 http://localhost:8080/maps/mymap/{z}/{x}/{y}.vector.pbf?debug=true
 ```
 
-The requested tile will be encode a layer with the `name` value set to `debug` and include two features:
+The requested tile will be encoded with a layer that has the `name` value set to `debug` and includes the three following features. 
 
- - `debug_outline`: a line feature that traces the border of the tile
- - `debug_text`: a point feature in the middle of the tile with the following tags:
- - `zxy`: a string with the `Z`, `X` and `Y` values formatted as: `Z:0, X:0, Y:0`
+ - `debug_outline` is a line feature that traces the border of the tile
+ - `debug_text` is a point feature in the middle of the tile with the following tags:
+ - `zxy` is a string with the `Z`, `X` and `Y` values formatted as: `Z:0, X:0, Y:0`
 
 ## Building from source
 
-Tegola is written in [Go](https://golang.org/) and requires Go 1.16 to compile from source. To build tegola from source, make sure you have Go installed and have cloned the repository. Navigate to the repository then run the following command:
+Tegola is written in [Go](https://golang.org/) and requires Go 1.16 to compile from the source. (We support the two newest versions of Go.) To build tegola from the source, make sure you have Go installed and have cloned the repository. Navigate to the repository then run the following command:
 
 ```bash
 cd cmd/tegola/ && go build -mod vendor
 ```
 
-You will now have a binary named `tegola` in the current directory which is [ready for running](#running-tegola).
+You will now have a binary named `tegola` in the current directory which is [ready to run.](#running-tegola-as-a-vector-tile-server).
 
 **Build Flags**
 The following build flags can be used to turn off certain features of tegola:
@@ -303,20 +303,20 @@ The following build flags can be used to turn off certain features of tegola:
 - `noRedisCache` - turn off the Redis cache back end.
 - `noPostgisProvider` - turn off the PostGIS data provider.
 - `noGpkgProvider` - turn off the GeoPackage data provider. Note, GeoPackage uses CGO and will be turned off if the environment variable `CGO_ENABLED=0` is set prior to building.
-- `noViewer` - turn off the built in viewer.
+- `noViewer` - turn off the built-in viewer.
 - `pprof` - enable [Go profiler](https://golang.org/pkg/net/http/pprof/). Start profile server by setting the environment `TEGOLA_HTTP_PPROF_BIND` environment (e.g. `TEGOLA_HTTP_PPROF_BIND=localhost:6060`).
 - `noPrometheusObserver` - turn off support for the Prometheus metric end point.
 
-Example of using the build flags to turn of the Redis cache back end, the GeoPackage provider and the built in viewer.
+Example of using the build flags to turn of the Redis cache back end, the GeoPackage provider and the built-in viewer.
 
 ```bash
 go build -tags 'noRedisCache noGpkgProvider noViewer'
 ```
 
 ## License
 
-See [license](LICENSE.md) file in repo.
+See [license](LICENSE.md) file in the repo.
 
 ## Looking for a vector tile style editor?
 
-Once you have tegola running you're likely going to want to work on your map's cartography. Give [fresco](https://github.com/go-spatial/fresco) a try!
+After Tegola is running you're likely going to want to work on your map's cartography. Give [fresco](https://github.com/go-spatial/fresco) a try!

atlas/atlas.go

@@ -55,7 +55,7 @@ func init() {
 	}
 }
 
-// defaultAtlas is instanitated for convenience
+// defaultAtlas is instantiated for convenience
 var defaultAtlas = &Atlas{}
 
 const (

cache/cache.go

@@ -21,7 +21,7 @@ type Interface interface {
 }
 
 // ParseKey will parse a string in the format /:map/:layer/:z/:x/:y into a Key struct. The :layer value is optional
-// ParseKey also supports other OS delimeters (i.e. Windows - "\")
+// ParseKey also supports other OS delimiters (i.e. Windows - "\")
 func ParseKey(str string) (*Key, error) {
 	var err error
 	var key Key
@@ -30,7 +30,7 @@ func ParseKey(str string) (*Key, error) {
 	// will fail our keyParts check since it uses backslashes.
 	str = filepath.ToSlash(str)
 
-	// remove the basepath and the first slash, then split the parts
+	// remove the base-path and the first slash, then split the parts
 	keyParts := strings.Split(strings.TrimLeft(str, "/"), "/")
 	// we're expecting a z/x/y scheme
 	if len(keyParts) < 3 || len(keyParts) > 5 {
@@ -57,7 +57,7 @@ func ParseKey(str string) (*Key, error) {
 		zxy = keyParts
 	}
 
-	// parse our URL vals to ints
+	// parse our URL vals into integers
 	var placeholder uint64
 	placeholder, err = strconv.ParseUint(zxy[0], 10, 32)
 	if err != nil || placeholder > tegola.MaxZ {
@@ -145,7 +145,7 @@ func Register(cacheType string, init InitFunc) error {
 	return nil
 }
 
-// Registered returns the caché's that have been registered.
+// Registered returns the cache's that have been registered.
 func Registered() (c []string) {
 	for k := range cache {
 		c = append(c, k)

cmd/tegola/cmd/cache/cache.go

@@ -169,7 +169,7 @@ TileChannelLoop:
 				break
 			}
 
-			{ // worker error occured.
+			{ // worker error occurred.
 				errLock.RLock()
 				e := mapTileErr
 				errLock.RUnlock()

cmd/tegola/cmd/cache/seed_purge.go

@@ -60,7 +60,7 @@ var (
 var SeedPurgeCmd = &cobra.Command{
 	Use:     "seed",
 	Aliases: []string{"purge"},
-	Short:   "seed or pruge tiles from the cache",
+	Short:   "seed or purge tiles from the cache",
 	Long:    "command to seed or purge tiles from the cache",
 	Example: "tegola cache seed --bounds lng,lat,lng,lat",
 }
@@ -83,7 +83,7 @@ func init() {
 	SeedPurgeCmd.AddCommand(TileNameCmd)
 }
 
-// seedPurgeCmdValidate will validate the presistent flags and set associated variables as needed
+// seedPurgeCmdValidate will validate the persistent flags and set associated variables as needed
 func seedPurgeCmdValidatePersistent(cmd *cobra.Command, args []string) error {
 
 	if cmd.HasParent() {
@@ -185,9 +185,9 @@ func seedPurgeCommand(cmd *cobra.Command, args []string) (err error) {
 	}()
 
 	log.Info("zoom list: ", zooms)
-	tilechannel := generateTilesForBounds(ctx, seedPurgeBounds, zooms)
+	tileChannel := generateTilesForBounds(ctx, seedPurgeBounds, zooms)
 
-	return doWork(ctx, tilechannel, seedPurgeMaps, cacheConcurrency, seedPurgeWorker)
+	return doWork(ctx, tileChannel, seedPurgeMaps, cacheConcurrency, seedPurgeWorker)
 }
 
 func generateTilesForBounds(ctx context.Context, bounds [4]float64, zooms []uint) *TileChannel {

cmd/tegola/cmd/server.go

@@ -29,7 +29,7 @@ var serverCmd = &cobra.Command{
 		gdcmd.OnComplete(provider.Cleanup)
 
 		// check config for server port setting
-		// if you set the port via the comand line it will override the port setting in the config
+		// if you set the port via the command line it will override the port setting in the config
 		if serverPort == defaultHTTPPort && conf.Webserver.Port != "" {
 			serverPort = string(conf.Webserver.Port)
 		}

cmd/tegola_lambda/main.go

@@ -116,7 +116,7 @@ func init() {
 }
 
 func main() {
-	// the second argument here tells algnhasa to watch for the MVT MimeType Content-Type headers
+	// the second argument here tells algnhsa to watch for the MVT MimeType Content-Type headers
 	// if it detects this in the response the payload will be base64 encoded. Lambda needs to be configured
 	// to handle binary responses so it can convert the base64 encoded payload back into binary prior
 	// to sending to the client

geometry.go

@@ -1,4 +1,4 @@
-// Package tegola describes the basic geometeries that can be used to convert to
+// Package tegola describes the basic geometries that can be used to convert to
 // and from.
 package tegola
 

maths/maths.go

@@ -1,5 +1,5 @@
 /*
-Package math contins generic math functions that we need for doing transforms.
+Package math contains generic math functions that we need for doing transforms.
 this package will augment the go math library.
 */
 package maths
@@ -331,6 +331,8 @@ func Exp2(p uint64) uint64 {
 
 // Minimum of uints
 func Min(x, y uint) uint {
-	if x < y {return x}
+	if x < y {
+		return x
+	}
 	return y
-}
+}

provider/provider.go

@@ -134,7 +134,7 @@ func (tu TilerUnion) Layers() ([]LayerInfo, error) {
 // InitFunc initialize a provider given a config map. The init function should validate the config map, and report any errors. This is called by the For function.
 type InitFunc func(dicter dict.Dicter) (Tiler, error)
 
-// CleanupFunc is called to when the system is shuting down, this allows the provider to cleanup.
+// CleanupFunc is called to when the system is shutting down, this allows the provider to cleanup.
 type CleanupFunc func()
 
 type pfns struct {

server/middleware_tile_cache.go

@@ -49,7 +49,7 @@ func TileCacheHandler(a *atlas.Atlas, next http.Handler) http.Handler {
 			// buffer which will hold a copy of the response for writing to the cache
 			var buff bytes.Buffer
 
-			// ovewrite our current responseWriter with a tileCacheResponseWriter
+			// overwrite our current responseWriter with a tileCacheResponseWriter
 			w = newTileCacheResponseWriter(w, &buff)
 
 			next.ServeHTTP(w, r)
@@ -89,7 +89,7 @@ func newTileCacheResponseWriter(resp http.ResponseWriter, w io.Writer) http.Resp
 	}
 }
 
-// tileCacheResponsWriter wraps http.ResponseWriter (https://golang.org/pkg/net/http/#ResponseWriter)
+// tileCacheResponseWriter wraps http.ResponseWriter (https://golang.org/pkg/net/http/#ResponseWriter)
 // to additionally write the response to a cache when there is a cache MISS
 type tileCacheResponseWriter struct {
 	// status response code

server/server.go

@@ -132,7 +132,7 @@ func hostName(r *http.Request) string {
 	return r.Host
 }
 
-// various checks to determin if the request is http or https. the scheme is needed for the TileURLs
+// various checks to determine if the request is http or https. the scheme is needed for the TileURLs
 // r.URL.Scheme can be empty if a relative request is issued from the client. (i.e. GET /foo.html)
 func scheme(r *http.Request) string {
 	if r.Header.Get("X-Forwarded-Proto") != "" {
@@ -174,13 +174,13 @@ func buildCapabilitiesURL(r *http.Request, uriParts []string, query url.Values)
 	return fmt.Sprintf("%v%v%v", URLRoot(r), path.Join(URIPrefix, uri), q)
 }
 
-// corsHanlder is used to respond to all OPTIONS requests for registered routes
+// corsHandler is used to respond to all OPTIONS requests for registered routes
 func corsHandler(w http.ResponseWriter, r *http.Request, params map[string]string) {
 	setHeaders(w)
 	return
 }
 
-// setHeaders sets deafult headers and user defined headers
+// setHeaders sets default headers and user defined headers
 func setHeaders(w http.ResponseWriter) {
 	// add our default CORS headers
 	for name, val := range DefaultCORSHeaders {