Skip to content

Commit a02dd26

Browse files
committed
[stdlib] String.Index.description: Explicitly note that the returned format is not stable
This tends to be generally through for most `description` properties, but explicitly calling it out should help preventing people from trying to parse the result in this case.
1 parent d3e9266 commit a02dd26

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

stdlib/public/core/StringIndex.swift

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -525,6 +525,9 @@ extension String.Index {
525525
}
526526

527527
/// A textual representation of this instance.
528+
///
529+
/// - Important: The contents of the returned string are not guaranteed to
530+
/// remain stable: they may arbitrarily change in any Swift release.
528531
@_alwaysEmitIntoClient // FIXME: Use @backDeployed
529532
@inline(never)
530533
public var description: String {

0 commit comments

Comments
 (0)