Skip to content

Commit 30cf437

Browse files
gcf-owl-bot[bot]parthea
gcf-owl-bot[bot]
and
parthea
authored
docs: [google-maps-routing] various formatting and grammar fixes for proto documentation (#12561)
- [ ] Regenerate this pull request now. BEGIN_COMMIT_OVERRIDE docs: various formatting and grammar fixes for proto documentation feat: adds support for new toll passes feat: adds support for specifying units in the ComputeRouteMatrix request END_COMMIT_OVERRIDE PiperOrigin-RevId: 623543022 Source-Link: googleapis/googleapis@fc89055 Source-Link: googleapis/googleapis-gen@e586c15 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtcm91dGluZy8uT3dsQm90LnlhbWwiLCJoIjoiZTU4NmMxNTZkODNhMjU4NDU5ODg1Nzg0NDRmMWMxZTBhODQyZmM0ZiJ9 --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>
1 parent 7b2fadf commit 30cf437

22 files changed

Lines changed: 155 additions & 122 deletions

‎packages/google-maps-routing/google/maps/routing_v2/services/routes/async_client.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ async def compute_routes(
265265
using URL parameter ``$fields`` or ``fields``, or by using an
266266
HTTP/gRPC header ``X-Goog-FieldMask`` (see the `available URL
267267
parameters and
268-
headers <https://cloud.google.com/apis/docs/system-parameters>`__.
268+
headers <https://cloud.google.com/apis/docs/system-parameters>`__).
269269
The value is a comma separated list of field paths. See detailed
270270
documentation about `how to construct the field
271271
paths <https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto>`__.
@@ -375,7 +375,7 @@ def compute_route_matrix(
375375
using the URL parameter ``$fields`` or ``fields``, or by using
376376
the HTTP/gRPC header ``X-Goog-FieldMask`` (see the `available
377377
URL parameters and
378-
headers <https://cloud.google.com/apis/docs/system-parameters>`__.
378+
headers <https://cloud.google.com/apis/docs/system-parameters>`__).
379379
The value is a comma separated list of field paths. See this
380380
detailed documentation about `how to construct the field
381381
paths <https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto>`__.

‎packages/google-maps-routing/google/maps/routing_v2/services/routes/client.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -662,7 +662,7 @@ def compute_routes(
662662
using URL parameter ``$fields`` or ``fields``, or by using an
663663
HTTP/gRPC header ``X-Goog-FieldMask`` (see the `available URL
664664
parameters and
665-
headers <https://cloud.google.com/apis/docs/system-parameters>`__.
665+
headers <https://cloud.google.com/apis/docs/system-parameters>`__).
666666
The value is a comma separated list of field paths. See detailed
667667
documentation about `how to construct the field
668668
paths <https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto>`__.
@@ -773,7 +773,7 @@ def compute_route_matrix(
773773
using the URL parameter ``$fields`` or ``fields``, or by using
774774
the HTTP/gRPC header ``X-Goog-FieldMask`` (see the `available
775775
URL parameters and
776-
headers <https://cloud.google.com/apis/docs/system-parameters>`__.
776+
headers <https://cloud.google.com/apis/docs/system-parameters>`__).
777777
The value is a comma separated list of field paths. See this
778778
detailed documentation about `how to construct the field
779779
paths <https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto>`__.

‎packages/google-maps-routing/google/maps/routing_v2/services/routes/transports/grpc.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ def compute_routes(
244244
using URL parameter ``$fields`` or ``fields``, or by using an
245245
HTTP/gRPC header ``X-Goog-FieldMask`` (see the `available URL
246246
parameters and
247-
headers <https://cloud.google.com/apis/docs/system-parameters>`__.
247+
headers <https://cloud.google.com/apis/docs/system-parameters>`__).
248248
The value is a comma separated list of field paths. See detailed
249249
documentation about `how to construct the field
250250
paths <https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto>`__.
@@ -309,7 +309,7 @@ def compute_route_matrix(
309309
using the URL parameter ``$fields`` or ``fields``, or by using
310310
the HTTP/gRPC header ``X-Goog-FieldMask`` (see the `available
311311
URL parameters and
312-
headers <https://cloud.google.com/apis/docs/system-parameters>`__.
312+
headers <https://cloud.google.com/apis/docs/system-parameters>`__).
313313
The value is a comma separated list of field paths. See this
314314
detailed documentation about `how to construct the field
315315
paths <https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto>`__.

‎packages/google-maps-routing/google/maps/routing_v2/services/routes/transports/grpc_asyncio.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ def compute_routes(
248248
using URL parameter ``$fields`` or ``fields``, or by using an
249249
HTTP/gRPC header ``X-Goog-FieldMask`` (see the `available URL
250250
parameters and
251-
headers <https://cloud.google.com/apis/docs/system-parameters>`__.
251+
headers <https://cloud.google.com/apis/docs/system-parameters>`__).
252252
The value is a comma separated list of field paths. See detailed
253253
documentation about `how to construct the field
254254
paths <https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto>`__.
@@ -314,7 +314,7 @@ def compute_route_matrix(
314314
using the URL parameter ``$fields`` or ``fields``, or by using
315315
the HTTP/gRPC header ``X-Goog-FieldMask`` (see the `available
316316
URL parameters and
317-
headers <https://cloud.google.com/apis/docs/system-parameters>`__.
317+
headers <https://cloud.google.com/apis/docs/system-parameters>`__).
318318
The value is a comma separated list of field paths. See this
319319
detailed documentation about `how to construct the field
320320
paths <https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto>`__.

‎packages/google-maps-routing/google/maps/routing_v2/types/fallback_info.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ class FallbackRoutingMode(proto.Enum):
5959
Not used.
6060
FALLBACK_TRAFFIC_UNAWARE (1):
6161
Indicates the ``TRAFFIC_UNAWARE``
62-
[google.maps.routing.v2.RoutingPreference] was used to
63-
compute the response.
62+
[``RoutingPreference``][google.maps.routing.v2.RoutingPreference]
63+
was used to compute the response.
6464
FALLBACK_TRAFFIC_AWARE (2):
6565
Indicates the ``TRAFFIC_AWARE``
66-
[RoutingPreference][google.maps.routing.v2.RoutingPreference]
66+
[``RoutingPreference``][google.maps.routing.v2.RoutingPreference]
6767
was used to compute the response.
6868
"""
6969
FALLBACK_ROUTING_MODE_UNSPECIFIED = 0

‎packages/google-maps-routing/google/maps/routing_v2/types/geocoding_results.py‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131

3232
class GeocodingResults(proto.Message):
3333
r"""Contains
34-
[GeocodedWaypoints][google.maps.routing.v2.GeocodedWaypoint] for
34+
[``GeocodedWaypoints``][google.maps.routing.v2.GeocodedWaypoint] for
3535
origin, destination and intermediate waypoints. Only populated for
3636
address waypoints.
3737
@@ -85,10 +85,9 @@ class GeocodedWaypoint(proto.Message):
8585
8686
This field is a member of `oneof`_ ``_intermediate_waypoint_request_index``.
8787
type_ (MutableSequence[str]):
88-
The type(s) of the result, in the form of
89-
zero or more type tags. Supported types:
90-
91-
https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types
88+
The type(s) of the result, in the form of zero or more type
89+
tags. Supported types: `Address types and address component
90+
types <https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types>`__.
9291
partial_match (bool):
9392
Indicates that the geocoder did not return an
9493
exact match for the original request, though it

‎packages/google-maps-routing/google/maps/routing_v2/types/location.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ class Location(proto.Message):
4343
360, where 0 specifies a heading of due North, 90 specifies
4444
a heading of due East, and so on. You can use this field
4545
only for ``DRIVE`` and ``TWO_WHEELER``
46-
[RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
46+
[``RouteTravelMode``][google.maps.routing.v2.RouteTravelMode].
4747
"""
4848

4949
lat_lng: latlng_pb2.LatLng = proto.Field(

‎packages/google-maps-routing/google/maps/routing_v2/types/maneuver.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@
2929

3030
class Maneuver(proto.Enum):
3131
r"""A set of values that specify the navigation action to take
32-
for the current step (e.g., turn left, merge, straight, etc.).
32+
for the current step (for example, turn left, merge, or
33+
straight).
3334
3435
Values:
3536
MANEUVER_UNSPECIFIED (0):

‎packages/google-maps-routing/google/maps/routing_v2/types/navigation_instruction.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@
3131

3232
class NavigationInstruction(proto.Message):
3333
r"""Encapsulates navigation instructions for a
34-
[RouteLegStep][google.maps.routing.v2.RouteLegStep]
34+
[``RouteLegStep``][google.maps.routing.v2.RouteLegStep].
3535
3636
Attributes:
3737
maneuver (google.maps.routing_v2.types.Maneuver):
3838
Encapsulates the navigation instructions for
39-
the current step (e.g., turn left, merge,
40-
straight, etc.). This field determines which
41-
icon to display.
39+
the current step (for example, turn left, merge,
40+
or straight). This field determines which icon
41+
to display.
4242
instructions (str):
4343
Instructions for navigating this step.
4444
"""

‎packages/google-maps-routing/google/maps/routing_v2/types/polyline.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ class PolylineEncoding(proto.Enum):
6161
``ENCODED_POLYLINE``.
6262
ENCODED_POLYLINE (1):
6363
Specifies a polyline encoded using the `polyline encoding
64-
algorithm <https://developers.google.com/maps/documentation/utilities/polylinealgorithm>`__.
64+
algorithm </maps/documentation/utilities/polylinealgorithm>`__.
6565
GEO_JSON_LINESTRING (2):
6666
Specifies a polyline using the `GeoJSON LineString
6767
format <https://tools.ietf.org/html/rfc7946#section-3.1.4>`__
@@ -90,7 +90,7 @@ class Polyline(proto.Message):
9090
This field is a member of `oneof`_ ``polyline_type``.
9191
geo_json_linestring (google.protobuf.struct_pb2.Struct):
9292
Specifies a polyline using the `GeoJSON LineString
93-
format <https://tools.ietf.org/html/rfc7946#section-3.1.4>`__
93+
format <https://tools.ietf.org/html/rfc7946#section-3.1.4>`__.
9494
9595
This field is a member of `oneof`_ ``polyline_type``.
9696
"""

0 commit comments

Comments
 (0)