Skip to content

Commit dabbb3a

Browse files
Google APIscopybara-github
authored andcommitted
docs: update documentation for RoutingPreference to better describe behaviors
PiperOrigin-RevId: 470798046
1 parent dab43ab commit dabbb3a

2 files changed

Lines changed: 14 additions & 9 deletions

File tree

google/maps/routing/v2/routing_preference.proto

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,23 @@ enum RoutingPreference {
3232
// No routing preference specified. Default to `TRAFFIC_UNAWARE`.
3333
ROUTING_PREFERENCE_UNSPECIFIED = 0;
3434

35-
// Computes routes without taking traffic conditions into consideration.
36-
// Suitable when traffic conditions don't matter. Using this value produces
37-
// the lowest latency.
35+
// Computes routes without taking live traffic conditions into consideration.
36+
// Suitable when traffic conditions don't matter or are not applicable.
37+
// Using this value produces the lowest latency.
38+
// Note: For `RouteTravelMode` DRIVE and TWO_WHEELER choice of route and
39+
// duration are based on road network and average time-independent traffic
40+
// conditions. Results for a given request may vary over time due to changes
41+
// in the road network, updated average traffic conditions, and the
42+
// distributed nature of the service. Results may also vary between
43+
// nearly-equivalent routes at any time or frequency.
3844
TRAFFIC_UNAWARE = 1;
3945

40-
// Calculates routes taking traffic conditions into consideration. In contrast
41-
// to `TRAFFIC_AWARE_OPTIMAL`, some optimizations are applied to significantly
42-
// reduce latency.
46+
// Calculates routes taking live traffic conditions into consideration.
47+
// In contrast to `TRAFFIC_AWARE_OPTIMAL`, some optimizations are applied to
48+
// significantly reduce latency.
4349
TRAFFIC_AWARE = 2;
4450

45-
// Calculates the routes taking traffic conditions into consideration,
51+
// Calculates the routes taking live traffic conditions into consideration,
4652
// without applying most performance optimizations. Using this value produces
4753
// the highest latency.
4854
TRAFFIC_AWARE_OPTIMAL = 3;

google/maps/routing/v2/waypoint.proto

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,7 @@ message Waypoint {
4949
// added to the `legs` array, but they do route the journey through the
5050
// waypoint. You can only set this value on waypoints that are intermediates.
5151
// The request fails if you set this field on terminal waypoints.
52-
// If
53-
// [ComputeRoutesRequest][google.maps.routing.v2.ComputeRoutesRequest.optimize_waypoint_order]
52+
// If `ComputeRoutesRequest.optimize_waypoint_order`
5453
// is set to true then this field cannot be set to
5554
// true; otherwise, the request fails.
5655
bool via = 3;

0 commit comments

Comments
 (0)