Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

33603: Enforce strict checking during the Sphinx documentation build process for azure-maps-route #34879

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sdk/maps/azure-maps-route/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ objects are async context managers and define async `close` methods.
The following sections provide several code snippets covering some of the most common Azure Maps Route tasks, including:

- [Request and Get Route Directions](#request-and-get-route-directions)
- [Request and Get Route Range](#reqest-and-get-route-range)
- [Request and Get Route Range](#request-and-get-route-range)
- [Get Route Matrix](#get-route-matrix)
- [Get Route Directions Batch](#get-route-directions-batch)

Expand Down
14 changes: 10 additions & 4 deletions sdk/maps/azure-maps-route/azure/maps/route/_route_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,9 @@ def get_route_directions(
parameter was not specified by the caller. "effectiveSettings" Default value is None.
:paramtype report: str or ~azure.maps.route.models.Report
:keyword filter_section_type: Specifies which of the section types is reported in the route
response. :code:`<br>`:code:`<br>`For example if sectionType = pedestrian the sections which
response.

For example if sectionType = pedestrian the sections which
are suited for pedestrians only are returned. Multiple types can be used. The default
sectionType refers to the travelMode input. By default travelMode is set to car. Known values
are: "carTrain", "country", "ferry", "motorway", "pedestrian", "tollRoad", "tollVignette",
Expand Down Expand Up @@ -191,7 +193,7 @@ def get_route_directions(
vehicles may not be allowed to drive on some roads. Default value is False.
:paramtype is_commercial_vehicle: bool
:keyword windingness: Level of turns for thrilling route. This parameter can only be used in
conjunction with ``routeType``=thrilling. Known values are: "low", "normal", and "high".
conjunction with ``routeType=thrilling``. Known values are: "low", "normal", and "high".
Default value is None.
:paramtype windingness: str or ~azure.maps.route.models.WindingnessLevel
:keyword incline_level: Degree of hilliness for thrilling route. This parameter can only be
Expand Down Expand Up @@ -600,7 +602,9 @@ def get_route_matrix(
best-estimate travel time. Known values are: "none" and "all". Default value is None.
:paramtype compute_travel_time: str or ~azure.maps.route.models.ComputeTravelTime
:keyword filter_section_type: Specifies which of the section types is reported in the route
response. :code:`<br>`:code:`<br>`For example if sectionType = pedestrian the sections which
response.

For example if sectionType = pedestrian the sections which
are suited for pedestrians only are returned. Multiple types can be used. The default
sectionType refers to the travelMode input. By default travelMode is set to car. Known values
are: "carTrain", "country", "ferry", "motorway", "pedestrian", "tollRoad", "tollVignette",
Expand Down Expand Up @@ -733,7 +737,9 @@ def begin_get_route_matrix_batch(
best-estimate travel time. Known values are: "none" and "all". Default value is None.
:paramtype compute_travel_time: str or ~azure.maps.route.models.ComputeTravelTime
:keyword filter_section_type: Specifies which of the section types is reported in the route
response. :code:`<br>`:code:`<br>`For example if sectionType = pedestrian the sections which
response.

For example if sectionType = pedestrian the sections which
are suited for pedestrians only are returned. Multiple types can be used. The default
sectionType refers to the travelMode input. By default travelMode is set to car. Known values
are: "carTrain", "country", "ferry", "motorway", "pedestrian", "tollRoad", "tollVignette",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ def get_batch_id_from_poller(polling_method):
# By default, use the latest supported API version
class MapsRouteClient(AsyncMapsRouteClientBase):
"""Azure Maps Route REST APIs.

:param credential:
Credential needed for the client to connect to Azure.
:type credential:
Expand Down Expand Up @@ -153,7 +154,9 @@ async def get_route_directions(
parameter was not specified by the caller. "effectiveSettings" Default value is None.
:paramtype report: str or ~azure.maps.route.models.Report
:keyword filter_section_type: Specifies which of the section types is reported in the route
response. :code:`<br>`:code:`<br>`For example if sectionType = pedestrian the sections which
response.

For example if sectionType = pedestrian the sections which
are suited for pedestrians only are returned. Multiple types can be used. The default
sectionType refers to the travelMode input. By default travelMode is set to car. Known values
are: "carTrain", "country", "ferry", "motorway", "pedestrian", "tollRoad", "tollVignette",
Expand Down Expand Up @@ -191,11 +194,11 @@ async def get_route_directions(
vehicles may not be allowed to drive on some roads. Default value is False.
:paramtype is_commercial_vehicle: bool
:keyword windingness: Level of turns for thrilling route. This parameter can only be used in
conjunction with ``routeType``=thrilling. Known values are: "low", "normal", and "high".
conjunction with ``routeType=thrilling``. Known values are: "low", "normal", and "high".
Default value is None.
:paramtype windingness: str or ~azure.maps.route.models.WindingnessLevel
:keyword incline_level: Degree of hilliness for thrilling route. This parameter can only be
used in conjunction with ``routeType``=thrilling. Known values are: "low", "normal", and
used in conjunction with ``routeType=thrilling``. Known values are: "low", "normal", and
"high". Default value is None.
:paramtype incline_level: str or ~azure.maps.route.models.InclineLevel
:keyword travel_mode: The mode of travel for the requested route. If not defined, default is
Expand Down Expand Up @@ -377,11 +380,11 @@ async def get_route_range(
Default value is None.
:paramtype travel_mode: str or ~azure.maps.route.models.TravelMode
:keyword incline_level: Degree of hilliness for thrilling route. This parameter can only be
used in conjunction with ``routeType``=thrilling. Known values are: "low", "normal", and
used in conjunction with ``routeType=thrilling``. Known values are: "low", "normal", and
"high". Default value is None.
:paramtype incline_level: str or ~azure.maps.route.models.InclineLevel
:keyword windingness: Level of turns for thrilling route. This parameter can only be used in
conjunction with ``routeType``=thrilling. Known values are: "low", "normal", and "high".
conjunction with ``routeType=thrilling``. Known values are: "low", "normal", and "high".
Default value is None.
:paramtype windingness: str or ~azure.maps.route.models.WindingnessLevel
:keyword vehicle_axle_weight: Weight per axle of the vehicle in kg. A value of 0 means that
Expand Down Expand Up @@ -600,7 +603,9 @@ async def get_route_matrix(
best-estimate travel time. Known values are: "none" and "all". Default value is None.
:paramtype compute_travel_time: str or ~azure.maps.route.models.ComputeTravelTime
:keyword filter_section_type: Specifies which of the section types is reported in the route
response. :code:`<br>`:code:`<br>`For example if sectionType = pedestrian the sections which
response.

For example if sectionType = pedestrian the sections which
are suited for pedestrians only are returned. Multiple types can be used. The default
sectionType refers to the travelMode input. By default travelMode is set to car. Known values
are: "carTrain", "country", "ferry", "motorway", "pedestrian", "tollRoad", "tollVignette",
Expand Down Expand Up @@ -634,11 +639,11 @@ async def get_route_matrix(
:keyword vehicle_weight: Weight of the vehicle in kilograms. Default value is 0.
:paramtype vehicle_weight: int
:keyword windingness: Level of turns for thrilling route. This parameter can only be used in
conjunction with ``routeType``=thrilling. Known values are: "low", "normal", and "high".
conjunction with ``routeType=thrilling``. Known values are: "low", "normal", and "high".
Default value is None.
:paramtype windingness: str or ~azure.maps.route.models.WindingnessLevel
:keyword incline_level: Degree of hilliness for thrilling route. This parameter can only be
used in conjunction with ``routeType``=thrilling. Known values are: "low", "normal", and
used in conjunction with ``routeType=thrilling``. Known values are: "low", "normal", and
"high". Default value is None.
:paramtype incline_level: str or ~azure.maps.route.models.InclineLevel
:keyword travel_mode: The mode of travel for the requested route. If not defined, default is
Expand Down Expand Up @@ -733,7 +738,9 @@ async def begin_get_route_matrix_batch(
best-estimate travel time. Known values are: "none" and "all". Default value is None.
:paramtype compute_travel_time: str or ~azure.maps.route.models.ComputeTravelTime
:keyword filter_section_type: Specifies which of the section types is reported in the route
response. :code:`<br>`:code:`<br>`For example if sectionType = pedestrian the sections which
response.

For example if sectionType = pedestrian the sections which
are suited for pedestrians only are returned. Multiple types can be used. The default
sectionType refers to the travelMode input. By default travelMode is set to car. Known values
are: "carTrain", "country", "ferry", "motorway", "pedestrian", "tollRoad", "tollVignette",
Expand Down Expand Up @@ -767,11 +774,11 @@ async def begin_get_route_matrix_batch(
:keyword vehicle_weight: Weight of the vehicle in kilograms. Default value is 0.
:paramtype vehicle_weight: int
:keyword windingness: Level of turns for thrilling route. This parameter can only be used in
conjunction with ``routeType``=thrilling. Known values are: "low", "normal", and "high".
conjunction with ``routeType=thrilling``. Known values are: "low", "normal", and "high".
Default value is None.
:paramtype windingness: str or ~azure.maps.route.models.WindingnessLevel
:keyword incline_level: Degree of hilliness for thrilling route. This parameter can only be
used in conjunction with ``routeType``=thrilling. Known values are: "low", "normal", and
used in conjunction with ``routeType=thrilling``. Known values are: "low", "normal", and
"high". Default value is None.
:paramtype incline_level: str or ~azure.maps.route.models.InclineLevel
:keyword travel_mode: The mode of travel for the requested route. If not defined, default is
Expand Down
34 changes: 17 additions & 17 deletions sdk/maps/azure-maps-route/azure/maps/route/models/_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -265,12 +265,12 @@ class GeoJsonObjectType(str, Enum, metaclass=CaseInsensitiveEnumMeta):

class GeoJsonObject(msrest.serialization.Model):
"""A valid ``GeoJSON`` object.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3>`_ for details.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3>`__ for details.

You probably want to use the sub-classes and not this class directly. Known
sub-classes are: GeoJsonFeature, GeoJsonFeatureCollection, GeoJsonGeometry,
GeoJsonGeometryCollection, GeoJsonLineString, GeoJsonMultiLineString,
GeoJsonMultiPoint, GeoJsonMultiPolygon, GeoJsonPoint, GeoJsonPolygon.
GeoJsonGeometryCollection, GeoJsonLineString, GeoJsonMultiLineString,
GeoJsonMultiPoint, GeoJsonMultiPolygon, GeoJsonPoint, GeoJsonPolygon.

All required parameters must be populated in order to send to Azure.

Expand Down Expand Up @@ -313,7 +313,7 @@ class GeoJsonFeatureData(msrest.serialization.Model):
All required parameters must be populated in order to send to Azure.

:param geometry: Required. A valid ``GeoJSON`` object. Please refer to `RFC 7946
<https://tools.ietf.org/html/rfc7946#section-3>`_ for details.
<https://tools.ietf.org/html/rfc7946#section-3>`__ for details.
:type geometry: ~azure.maps.route.models.GeoJsonObject
:param properties: Properties can contain any additional metadata about the ``Feature``. Value
can be any JSON object or a JSON null value.
Expand Down Expand Up @@ -348,12 +348,12 @@ def __init__(

class GeoJsonFeature(GeoJsonObject, GeoJsonFeatureData):
"""A valid ``GeoJSON Feature`` object type.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.2>`_ for details.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.2>`__ for details.

All required parameters must be populated in order to send to Azure.

:param geometry: Required. A valid ``GeoJSON`` object. Please refer to `RFC 7946
<https://tools.ietf.org/html/rfc7946#section-3>`_ for details.
<https://tools.ietf.org/html/rfc7946#section-3>`__ for details.
:type geometry: ~azure.maps.route.models.GeoJsonObject
:param properties: Properties can contain any additional metadata about the ``Feature``. Value
can be any JSON object or a JSON null value.
Expand Down Expand Up @@ -427,7 +427,7 @@ def __init__(

class GeoJsonFeatureCollection(GeoJsonObject, GeoJsonFeatureCollectionData):
"""A valid ``GeoJSON FeatureCollection`` object type.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.3>`_ for details.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.3>`__ for details.

All required parameters must be populated in order to send to Azure.

Expand Down Expand Up @@ -466,7 +466,7 @@ class GeoJsonGeometry(GeoJsonObject):
"""A valid ``GeoJSON`` geometry object.
The type must be one of the seven valid GeoJSON geometry types -
Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1>`_ for details.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1>`__ for details.

All required parameters must be populated in order to send to Azure.

Expand Down Expand Up @@ -524,7 +524,7 @@ def __init__(

class GeoJsonGeometryCollection(GeoJsonObject, GeoJsonGeometryCollectionData):
"""A valid ``GeoJSON GeometryCollection`` object type.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.8>`_ for details.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.8>`__ for details.

All required parameters must be populated in order to send to Azure.

Expand Down Expand Up @@ -588,7 +588,7 @@ def __init__(

class GeoJsonLineString(GeoJsonObject, GeoJsonLineStringData):
"""A valid ``GeoJSON LineString`` geometry type.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.4>`_ for details.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.4>`__ for details.

All required parameters must be populated in order to send to Azure.

Expand Down Expand Up @@ -674,7 +674,7 @@ def __init__(

class GeoJsonMultiLineString(GeoJsonObject, GeoJsonMultiLineStringData):
"""A valid ``GeoJSON MultiLineString`` geometry type.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.5>`_ for details.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.5>`__ for details.

All required parameters must be populated in order to send to Azure.

Expand All @@ -700,7 +700,7 @@ def __init__(

class GeoJsonMultiPoint(GeoJsonObject, GeoJsonMultiPointData):
"""A valid ``GeoJSON MultiPoint`` geometry type.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.3>`_ for details.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.3>`__ for details.

All required parameters must be populated in order to send to Azure.

Expand All @@ -726,7 +726,7 @@ def __init__(

class GeoJsonMultiPolygon(GeoJsonObject, GeoJsonMultiPolygonData):
"""A valid ``GeoJSON MultiPolygon`` object type.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.7>`_ for details.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.7>`__ for details.

All required parameters must be populated in order to send to Azure.

Expand Down Expand Up @@ -771,7 +771,7 @@ class GeoJsonPointData(msrest.serialization.Model):
:param coordinates: Required. A ``Position`` is an array of numbers with two or more elements.
The first two elements are *longitude* and *latitude*, precisely in that order.
*Altitude/Elevation* is an optional third element. Please refer to `RFC 7946
<https://tools.ietf.org/html/rfc7946#section-3.1.1>`_ for details.
<https://tools.ietf.org/html/rfc7946#section-3.1.1>`__ for details.
:type coordinates: LatLon
"""

Expand All @@ -795,14 +795,14 @@ def __init__(

class GeoJsonPoint(GeoJsonObject, GeoJsonPointData):
"""A valid ``GeoJSON Point`` geometry type.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.2>`_ for details.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.2>`__ for details.

All required parameters must be populated in order to send to Azure.

:param coordinates: Required. A ``Position`` is an array of numbers with two or more elements.
The first two elements are *longitude* and *latitude*, precisely in that order.
*Altitude/Elevation* is an optional third element. Please refer to `RFC 7946
<https://tools.ietf.org/html/rfc7946#section-3.1.1>`_ for details.
<https://tools.ietf.org/html/rfc7946#section-3.1.1>`__ for details.
:type coordinates: LatLon
:param type: Required. Specifies the ``GeoJSON`` type. Must be one of the nine valid GeoJSON
object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon,
Expand Down Expand Up @@ -862,7 +862,7 @@ def __init__(

class GeoJsonPolygon(GeoJsonObject, GeoJsonPolygonData):
"""A valid ``GeoJSON Polygon`` geometry type.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.6>`_ for details.
Please refer to `RFC 7946 <https://tools.ietf.org/html/rfc7946#section-3.1.6>`__ for details.

All required parameters must be populated in order to send to Azure.

Expand Down
1 change: 1 addition & 0 deletions sdk/maps/azure-maps-route/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ pyright = false
type_check_samples = false
verifytypes = false
ci_enabled = false
strict_sphinx = true
Loading