Skip to content

Commit 327b397

Browse files
committed
Fixed inaccurate RoadGraph.Location documentation
1 parent 1431939 commit 327b397

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

Sources/MapboxCoreNavigation/EHorizon/RoadGraphPath.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ extension RoadGraph {
66

77
/** A position along a linear object in the road graph. */
88
public struct Path {
9-
/** The edge identifiers that form the linear object. */
9+
/** The edge identifiers that fully or partially coincide with the linear object. */
1010
public let edgeIdentifiers: [ElectronicHorizon.Edge.Identifier]
1111

12-
/** The distance from the start of the linear object to the user’s location as a fraction of the linear object’s length from 0 to 1. */
12+
/** The distance from the start of an edge to the start of the linear object as a fraction of the edge’s length from 0 to 1. */
1313
public let fractionFromStart: Double
1414

15-
/** The distance from the the user’s location to the end of the linear object as a fraction of the linear object’s length from 0 to 1. */
15+
/** The distance from the end of the linear object to the end of an edge as a fraction of the edge’s length from 0 to 1. */
1616
public let fractionToEnd: Double
1717

1818
/** Length of a path, measured in meters. */

Sources/MapboxCoreNavigation/EHorizon/RoadGraphPosition.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ extension RoadGraph {
66
/** The position of a point object in the road graph. */
77
public struct Position {
88

9-
/** The edge identifier that forms the point object. */
9+
/** The edge identifier along which the point object lies. */
1010
public let edgeIdentifier: ElectronicHorizon.Edge.Identifier
1111

12-
/** The distance from the start of the point object to the user’s location as a fraction of the point object’s length from 0 to 1. */
12+
/** The distance from the start of an edge to the point object as a fraction of the edge’s length from 0 to 1. */
1313
public let fractionFromStart: Double
1414

1515
init(_ native: GraphPosition) {

0 commit comments

Comments
 (0)