[skip ci] Add comments about order of post-processing calls

2017-06-01 11:00:54 +02:00
parent dd009322de
commit d262c4dfaa
2 changed files with 10 additions and 0 deletions
@@ -165,6 +165,10 @@ class RouteAPI : public BaseAPI
                 * to find a via point.
                 * The same exit will be emitted, though, if we should start routing at S, making
                 * the overall response consistent.
+                 *
+                 * ⚠ CAUTION: order of post-processing steps is important
+                 *    - postProcess must be called before collapseTurnInstructions that expects
+                 *      post-processed roundabouts without Exit instructions
                 */

                guidance::trimShortSegments(steps, leg_geometry);