Open-Harbor/osrm-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

Fix typo in api.md (#6567)

Browse Source 
* Fix typo in api.md

Signed-off-by: Pratik <pratikrajput1199@gmail.com>
Co-authored-by: Siarhei Fedartsou <siarhei.fedartsou@gmail.com>
This commit is contained in:
Pratik Rajput 2023-03-09 21:40:42 +05:30 committed by GitHub
parent 51e04209e3
commit a63ba91c8f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/osrm-backend.yml vendored
View File

@ -29,7 +29,7 @@ jobs:
ENABLE_APPLE_SILICON: "OFF" ENABLE_APPLE_SILICON: "OFF"
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- run: pip install conan==1.53.0 - run: pip install "conan<2.0.0"
- run: conan --version - run: conan --version
- run: cmake --version - run: cmake --version
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
@ -400,7 +400,7 @@ jobs:
- name: Install dev dependencies - name: Install dev dependencies
run: | run: |
python3 -m pip install conan==1.53.0 python3 -m pip install "conan<2.0.0"
# workaround for issue that GitHub Actions seems to not adding it to PATH after https://github.com/actions/runner-images/pull/6499 # workaround for issue that GitHub Actions seems to not adding it to PATH after https://github.com/actions/runner-images/pull/6499
# and that's why CI cannot find conan executable installed above # and that's why CI cannot find conan executable installed above

2
docs/nodejs/api.md
View File

@ -248,7 +248,7 @@ osrm.match(options, function(err, response) {
Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** containing `tracepoints` and `matchings`. Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** containing `tracepoints` and `matchings`.
**`tracepoints`** Array of [`Ẁaypoint`](#waypoint) objects representing all points of the trace in order. **`tracepoints`** Array of [`Ẁaypoint`](#waypoint) objects representing all points of the trace in order.
If the trace point was ommited by map matching because it is an outlier, the entry will be null. If the trace point was omitted by map matching because it is an outlier, the entry will be null.
Each `Waypoint` object has the following additional properties, Each `Waypoint` object has the following additional properties,
1) `matchings_index`: Index to the 1) `matchings_index`: Index to the
[`Route`](#route) object in matchings the sub-trace was matched to, [`Route`](#route) object in matchings the sub-trace was matched to,

2
src/nodejs/node_osrm.cpp
View File

@ -491,7 +491,7 @@ Napi::Value Engine::tile(const Napi::CallbackInfo &info)
* *
* @returns {Object} containing `tracepoints` and `matchings`. * @returns {Object} containing `tracepoints` and `matchings`.
* **`tracepoints`** Array of [`Ẁaypoint`](#waypoint) objects representing all points of the trace in order. * **`tracepoints`** Array of [`Ẁaypoint`](#waypoint) objects representing all points of the trace in order.
* If the trace point was ommited by map matching because it is an outlier, the entry will be null. * If the trace point was omitted by map matching because it is an outlier, the entry will be null.
* Each `Waypoint` object has the following additional properties, * Each `Waypoint` object has the following additional properties,
* 1) `matchings_index`: Index to the * 1) `matchings_index`: Index to the
* [`Route`](#route) object in matchings the sub-trace was matched to, * [`Route`](#route) object in matchings the sub-trace was matched to,