Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Deubler <tim.deubler@here.com>
  • Loading branch information
TerminalTim committed Jan 18, 2024
1 parent 73929ae commit 29c01e1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions packages/core/src/providers/FeatureProvider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -683,7 +683,7 @@ export class FeatureProvider extends Provider {
* Finds the optimal path between two coordinates on a GeoJSON road network, considering various options.
* By default, the weight function returns the distance of the road segment, a lower distance implies a shorter route and is considered more favorable.
* If you have specific criteria such as road quality, traffic conditions, or other factors influencing the desirability of a road segment, you can customize the weight function accordingly.
* Only data available locally will be taken into account for pathfinding.
* Pathfinding will consider only the locally cached data available on the client.
*
* @experimental
*
Expand Down Expand Up @@ -712,7 +712,7 @@ export class FeatureProvider extends Provider {
* return data.distance; // Default implementation uses distance as the weight
* },
* };
* const result = await findPath(pathOptions);
* const result = await provider.findPath(pathOptions);
* console.log(result);
* ```
*/
Expand Down

0 comments on commit 29c01e1

Please sign in to comment.