Skip to content

Commit

Permalink
Clarify docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
ianthetechie committed May 10, 2024
1 parent 6a55112 commit df25c0c
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/generated/models/RouteLeg.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export interface RouteLeg {
*/
elevationInterval?: number;
/**
* An array of elevation values sampled every `elevation_interval` `units`.
* An array of elevation values sampled every `elevation_interval`. Units are either metric or imperial depending on the value of `units`.
* @type {Array<number>}
* @memberof RouteLeg
*/
Expand Down
2 changes: 1 addition & 1 deletion src/generated/models/RouteRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ export interface RouteRequest {
*/
alternates?: number;
/**
* If greater than zero, attempts to include elevation along the route at regular intervals. The "native" internal resolution is 30m, so we recommend you use this when possible. This number is interpreted in the same units as the directions request.
* If greater than zero, attempts to include elevation along the route at regular intervals. The "native" internal resolution is 30m, so we recommend you use this when possible. This number is interpreted as either meters or feet depending on the unit parameter.
* Elevation for route sections containing a bridge or tunnel is interpolated linearly. This doesn't always match the true elevation of the bridge/tunnel, but it prevents sharp artifacts from the surrounding terrain. This functionality is unique to the route endpoint and is not available via the elevation API.
* @type {number}
* @memberof RouteRequest
Expand Down

0 comments on commit df25c0c

Please sign in to comment.