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

Correct a typo in the docs (#3706)

Browse Source 
Fix the typo of `summary` parameter table that was mislabeled `steps`.
This commit is contained in:
Kajari Ghosh 2017-02-13 16:45:24 -05:00 committed by Daniel Patterson
parent e75278f9c2
commit 335362315c
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/http.md
View File

@ -483,9 +483,9 @@ Represents a route between two waypoints.
- `distance`: The distance traveled by this route leg, in `float` meters.
- `duration`: The estimated travel time, in `float` number of seconds.
- `weight`: The calculated weight of the route leg.
- `summary`: Summary of the route taken as `string`. Depends on the `steps` parameter:
- `summary`: Summary of the route taken as `string`. Depends on the `summary` parameter:
| steps | |
| summary | |
|--------------|-----------------------------------------------------------------------|
| true | Names of the two major roads used. Can be empty if route is too short.|
| false | empty `string` |