summaryrefslogtreecommitdiff
path: root/platform/ios/src/MGLUserLocation.h
diff options
context:
space:
mode:
Diffstat (limited to 'platform/ios/src/MGLUserLocation.h')
-rw-r--r--platform/ios/src/MGLUserLocation.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/platform/ios/src/MGLUserLocation.h b/platform/ios/src/MGLUserLocation.h
index 91abadbcb7..4e01cf00c9 100644
--- a/platform/ios/src/MGLUserLocation.h
+++ b/platform/ios/src/MGLUserLocation.h
@@ -34,7 +34,8 @@ MGL_EXPORT
The heading of the user location. (read-only)
This property is `nil` if the user location tracking mode is not
- `MGLUserTrackingModeFollowWithHeading`.
+ `MGLUserTrackingModeFollowWithHeading` or if
+ `MGLMapView.showsUserHeadingIndicator` is disabled.
*/
@property (nonatomic, readonly, nullable) CLHeading *heading;