Improve spelling and wording in source code, comments and documentation (#7215)

Author: afarber

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Unreleased
   - Changes from 6.0.0
+    - Misc:
+      - FIXED: Minor misspellings found in source code, comments and documents [#7215](https://github.com/Project-OSRM/osrm-backend/pull/7215)
 
 # 6.0.0
   - Changes from 6.0.0 RC2: None

CONTRIBUTING.md

@@ -28,8 +28,8 @@ if [ x"$remote" = xorigin  ] ; then
     fi
 fi
 ```
-could check code format, modify a local repository and reject push due to unstaged formatting changes.
-Also `pre-push` hook  rejects direct pushes to `origin/master`.
+could check code format, modify a local repository and reject the push due to unstaged formatting changes.
+Also the `pre-push` hook rejects direct pushes to `origin/master`.
 
 ⚠️ `scripts/format.sh` checks all local files that match `*.cpp` or `*.hpp` patterns.
 
@@ -49,7 +49,7 @@ If your work is going in entirely the wrong direction, there is a good chance so
 Everyone is encouraged to read PRs of other people and give feedback.
 
 For every significant code change we require a pull request review before it is merged.
-If your pull request modifies the API this need to be signed of by a team discussion.
+If your pull request modifies the API this needs to be signed off by a team discussion.
 This means you will need to find another member of the team with commit access and request a review of your pull request.
 
 Once your pull request is reviewed you can merge it! If you don't have commit access, ping someone that has commit access.

README.md

@@ -1,11 +1,11 @@
 ## Open Source Routing Machine
 
-
 [![osrm-backend CI](https://github.com/Project-OSRM/osrm-backend/actions/workflows/osrm-backend.yml/badge.svg)](https://github.com/Project-OSRM/osrm-backend/actions/workflows/osrm-backend.yml) [![Discord](https://img.shields.io/discord/1034487840219860992)](https://discord.gg/es9CdcCXcb)
 
 High performance routing engine written in C++ designed to run on OpenStreetMap data.
 
 The following services are available via HTTP API, C++ library interface and NodeJs wrapper:
+
 - Nearest - Snaps coordinates to the street network and returns the nearest matches
 - Route - Finds the fastest route between coordinates
 - Table - Computes the duration or distances of the fastest route between all pairs of supplied coordinates
@@ -18,6 +18,7 @@ To quickly try OSRM use our [demo server](http://map.project-osrm.org) which com
 For a quick introduction about how the road network is represented in OpenStreetMap and how to map specific road network features have a look at [the OSM wiki on routing](https://wiki.openstreetmap.org/wiki/Routing) or [this guide about mapping for navigation](https://web.archive.org/web/20221206013651/https://labs.mapbox.com/mapping/mapping-for-navigation/).
 
 Related [Project-OSRM](https://github.com/Project-OSRM) repositories:
+
 - [osrm-frontend](https://github.com/Project-OSRM/osrm-frontend) - User-facing frontend with map. The demo server runs this on top of the backend
 - [osrm-text-instructions](https://github.com/Project-OSRM/osrm-text-instructions) - Text instructions from OSRM route response
 - [osrm-backend-docker](https://github.com/project-osrm/osrm-backend/pkgs/container/osrm-backend) - Ready to use Docker images
@@ -41,10 +42,11 @@ Related [Project-OSRM](https://github.com/Project-OSRM) repositories:
 The easiest and quickest way to setup your own routing engine is to use Docker images we provide.
 
 There are two pre-processing pipelines available:
+
 - Contraction Hierarchies (CH)
 - Multi-Level Dijkstra (MLD)
 
-we recommend using MLD by default except for special use-cases such as very large distance matrices where CH is still a better fit for the time being.
+We recommend using MLD by default except for special use cases such as very large distance matrices where CH is still a better fit for the time being.
 In the following we explain the MLD pipeline.
 If you want to use the CH pipeline instead replace `osrm-partition` and `osrm-customize` with a single `osrm-contract` and change the algorithm option for `osrm-routed` to `--algorithm ch`.
 
@@ -65,7 +67,7 @@ The flag `-v "${PWD}:/data"` creates the directory `/data` inside the docker con
     docker run -t -v "${PWD}:/data" ghcr.io/project-osrm/osrm-backend osrm-partition /data/berlin-latest.osrm || echo "osrm-partition failed"
     docker run -t -v "${PWD}:/data" ghcr.io/project-osrm/osrm-backend osrm-customize /data/berlin-latest.osrm || echo "osrm-customize failed"
 
-Note there is no `berlin-latest.osrm` file, but multiple `berlin-latest.osrm.*` files, i.e. `berlin-latest.osrm` is not file path, but "base" path referring to set of files and there is an option to omit this `.osrm` suffix completely(e.g. `osrm-partition /data/berlin-latest`).
+Note there is no `berlin-latest.osrm` file, but multiple `berlin-latest.osrm.*` files, i.e. `berlin-latest.osrm` is not a file path, but a "base" path referring to a set of files and there is an option to omit this `.osrm` suffix completely (e.g. `osrm-partition /data/berlin-latest`).
 
     docker run -t -i -p 5000:5000 -v "${PWD}:/data" ghcr.io/project-osrm/osrm-backend osrm-routed --algorithm mld /data/berlin-latest.osrm
 
@@ -86,13 +88,13 @@ After adding yourself to the `docker` group make sure to log out and back in aga
 
 We support the following images in the Container Registry:
 
-Name | Description
------|------
-`latest` | `master` compiled with release flag
-`latest-assertions` | `master` compiled with with release flag, assertions enabled and debug symbols
-`latest-debug` | `master` compiled with debug flag
-`<tag>` | specific tag compiled with release flag
-`<tag>-debug` | specific tag compiled with debug flag
+| Name                | Description                                                                    |
+| ------------------- | ------------------------------------------------------------------------------ |
+| `latest`            | `master` compiled with release flag                                            |
+| `latest-assertions` | `master` compiled with with release flag, assertions enabled and debug symbols |
+| `latest-debug`      | `master` compiled with debug flag                                              |
+| `<tag>`             | specific tag compiled with release flag                                        |
+| `<tag>-debug`       | specific tag compiled with debug flag                                          |
 
 ### Building from Source
 
@@ -166,7 +168,6 @@ For usage details have a look [these API docs](docs/nodejs/api.md).
 
 An exemplary implementation by a 3rd party with Docker and Node.js can be found [here](https://github.com/door2door-io/osrm-express-server-demo).
 
-
 ## References in publications
 
 When using the code in a (scientific) publication, please cite

docs/developing.md

@@ -30,7 +30,7 @@ For outputting data into our file (debug.geojson), we simply need to call the ma
 (or `guard.Write(list_of_node_ids)` if you created an instance).
 
 ### Possible Scopeguard Location
-Think of the scopeguard as you would do of any reference. If you wan't to access to logging during a call, the guard object must be alive and valid.
+Think of the scopeguard as you would do of any reference. If you want to access logging during a call, the guard object must be alive and valid.
 
 As an example: a good location to create a scopeguard to log decisions in the edge-based-graph-factory would be right before we run it ([here](https://github.com/Project-OSRM/osrm-backend/blob/a933b5d94943bf3edaf42c84a614a99650d23cba/src/extractor/extractor.cpp#L497)). If you put `util::ScopedGeojsonLoggerGuard<util::NodeIdVectorToLineString> geojson_guard( "debug.geojson", node_coordinate_vector);` at that location, you can then print `util::ScopedGeojsonLoggerGuard<util::NodeIdVectorToLineString>::Write(list_of_node_ids);` anywhere within the `edge-based-graph-factory`.
 
@@ -47,7 +47,7 @@ For each set of template parameters, only the most recent guard will actually pr
 
 Will not provide a way to write into two files, but only `debug-2` will actually contain features.
 
-We cannot nest-these calls.
+We cannot nest these calls.
 
 If we want to use the same policy for multiple files, we need to use different template parameters both for the logger and the guard.
 

docs/http.md

@@ -94,7 +94,7 @@ Every response object has a `code` property containing one of the strings below
 | `TooBig`          | The request size violates one of the service-specific request size restrictions. |
 | `DisabledDataset` | The request tried to access a disabled dataset.                                  |
 
-- `message` is a **optional** human-readable error message. All other status types are service-dependent.
+- `message` is an **optional** human-readable error message. All other status types are service-dependent.
 - In case of an error the HTTP status code will be `400`. Otherwise, the HTTP status code will be `200` and `code` will be `Ok`.
 
 #### Data version
@@ -130,7 +130,7 @@ In addition to the [general options](#general-options) the following options are
 |------------|------------------------------|----------------------------------------------------|
 |number      |`integer >= 1` (default `1`)  |Number of nearest segments that should be returned. |
 
-As `waypoints` is a single thing, returned by that service, using it with the option `skip_waypoints` set to `true` is quite useless, but still
+As `waypoints` is a single thing returned by that service, using it with the option `skip_waypoints` set to `true` is quite useless, but still
 possible. In that case, only the `code` field will be returned.
 
 **Response**
@@ -211,7 +211,7 @@ In addition to the [general options](#general-options) the following options are
 |steps       |`true`, `false` (default)                    |Returned route steps for each route leg                                        |
 |annotations |`true`, `false` (default), `nodes`, `distance`, `duration`, `datasources`, `weight`, `speed`  |Returns additional metadata for each coordinate along the route geometry.      |
 |geometries  |`polyline` (default), `polyline6`, `geojson` |Returned route geometry format (influences overview and per step)              |
-|overview    |`simplified` (default), `full`, `false`      |Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all.|
+|overview    |`simplified` (default), `full`, `false`      |Add overview geometry either full, simplified according to highest zoom level it could be displayed on, or not at all.|
 |continue\_straight |`default` (default), `true`, `false`  |Forces the route to keep going straight at waypoints constraining uturns there even if it would be faster. Default value depends on the profile. |
 |waypoints   | `{index};{index};{index}...`                |Treats input coordinates indicated by given indices as waypoints in returned Match object. Default is to treat all input coordinates as waypoints.    |
 
@@ -432,7 +432,7 @@ In addition to the [general options](#general-options) the following options are
 |steps       |`true`, `false` (default)                       |Returned route steps for each route                                                       |
 |geometries  |`polyline` (default), `polyline6`, `geojson`    |Returned route geometry format (influences overview and per step)                         |
 |annotations |`true`, `false` (default), `nodes`, `distance`, `duration`, `datasources`, `weight`, `speed`  |Returns additional metadata for each coordinate along the route geometry.                 |
-|overview    |`simplified` (default), `full`, `false`         |Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all.|
+|overview    |`simplified` (default), `full`, `false`         |Add overview geometry either full, simplified according to highest zoom level it could be displayed on, or not at all.|
 |timestamps  |`{timestamp};{timestamp}[;{timestamp} ...]`     |Timestamps for the input locations in seconds since UNIX epoch. Timestamps need to be monotonically increasing. |
 |radiuses    |`{radius};{radius}[;{radius} ...]`              |Standard deviation of GPS precision used for map matching. If applicable use GPS accuracy.|
 |gaps        |`split` (default), `ignore`                     |Allows the input track splitting based on huge timestamp gaps between points.             |
@@ -489,7 +489,7 @@ In addition to the [general options](#general-options) the following options are
 |steps       |`true`, `false` (default)                       |Returned route instructions for each trip                                  |
 |annotations |`true`, `false` (default), `nodes`, `distance`, `duration`, `datasources`, `weight`, `speed` |Returns additional metadata for each coordinate along the route geometry.  |
 |geometries  |`polyline` (default), `polyline6`, `geojson`    |Returned route geometry format (influences overview and per step)          |
-|overview    |`simplified` (default), `full`, `false`         |Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all.|
+|overview    |`simplified` (default), `full`, `false`         |Add overview geometry either full, simplified according to highest zoom level it could be displayed on, or not at all.|
 
 **Fixing Start and End Points**
 
@@ -1036,7 +1036,7 @@ Almost the same as `json` Step object. The following properties differ:
 | `ExitRoundabout` | Describes a maneuver exiting a roundabout (usually preceded by a `roundabout` instruction)                                                                                                                                                                                                                                  |
 | `ExitRotary`     | Describes the maneuver exiting a rotary (large named roundabout)                                                                                                                                                                                                                                                             |
 
-- `driving_side`: `bool` Ttrue stands for the left side driving.
+- `driving_side`: `bool` True stands for left side driving.
 - `intersections`: `[Intersection]` Same as `json` intersections field, but different format.
 
 ### Intersection object
@@ -1102,7 +1102,7 @@ Exactly the same as `json` annotation object.
 A point on Earth.
 
 ***Properties***
-- `longitute`: `float` Point's longitude
+- `longitude`: `float` Point's longitude
 - `latitude`: `float` Point's latitude
 
 ### Uint64Pair