docs: add missing encoder options to documentation (#1752)

GIScience · Mar 15, 2024 · d90a23f · d90a23f
1 parent b408ab7
commit d90a23f
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -78,6 +78,7 @@ RELEASING:
 - separate docker image build from test workflow. Build nightly on schedule if there are changes to main ([#1689](https://github.com/GIScience/openrouteservice/pull/1689))
 - refactor isochrone builder classes ([#1699](https://github.com/GIScience/openrouteservice/pull/1699))
 - unify edge splitting across isochrone builders, and split edges based on coordinates rather than their actual distance in meters ([#1708](https://github.com/GIScience/openrouteservice/pull/1708))
+- add missing encoder_options to the documentation [#1752](https://github.com/GIScience/openrouteservice/pull/1752)
 
 ### Deprecated
 - JSON configuration and related classes ([#1506](https://github.com/GIScience/openrouteservice/pull/1506))

diff --git a/docs/run-instance/configuration/ors/engine/profiles.md b/docs/run-instance/configuration/ors/engine/profiles.md
@@ -53,11 +53,15 @@ Properties for each (enabled) profile are set under `ors.engine.profiles.<profil
 
 Properties beneath `ors.engine.profiles.*.encoder_options`:
 
-| key                      | type    | description                                                                                                                                                                      | example value                  |
-|--------------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|
-| turn_costs               | boolean | Should turn restrictions be respected.                                                                                                                                           | `turn_costs=true`              |
-| problematic_speed_factor | number  | For wheelchair profile only! Travel speeds on edges classified as problematic for wheelchair users are multiplied by this factor, use to set slow traveling speeds on such ways  | `problematic_speed_factor=0.7` |
-| preferred_speed_factor   | number  | For wheelchair profile only! Travel speeds on edges classified as preferable for wheelchair users are multiplied by this factor, use to set faster traveling speeds on such ways | `preferred_speed_factor=1.2`   |
+| key                      | type    | profiles         | description                                                                                                                                                                                                                   | example value |
+|--------------------------|---------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
+| block_fords              | boolean | *                | Do not route through fords.                                                                                                                                                                                                   | `true`        |
+| consider_elevation       | boolean | bike-*           | The maximum possible speed is the bike-type specific maximum downhill speed, which is higher than the usual maximum speed.                                                                                                    | `true`        |
+| maximum_grade_level      | number  | car, hgv         | Relates to the quality of tracks as described in [tracktype](https://wiki.openstreetmap.org/wiki/Key:tracktype). Specifying e.g. maximum_grade_level=1 means that tracktype=grade2 and below won't be considered for routing. | `3`           |
+| preferred_speed_factor   | number  | wheelchair       | Travel speeds on edges classified as preferable for wheelchair users are multiplied by this factor, use to set faster traveling speeds on such ways                                                                           | `1.2`         |
+| problematic_speed_factor | number  | wheelchair       | Travel speeds on edges classified as problematic for wheelchair users are multiplied by this factor, use to set slow traveling speeds on such ways                                                                            | `0.7`         |
+| turn_costs               | boolean | car, hgv, bike-* | Should turn restrictions be respected.                                                                                                                                                                                        | `true`        |
+| use_acceleration         | boolean | car, hgv         | Models how a vehicle would accelerate on the road segment to the maximum allowed speed. In practice it reduces speed on shorter road segments such as ones between nearby intersections in a city.                            | `true`        |
 
 ## preparation