averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-21 12:14:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix documentaion for the Unicode.ParseResult

Browse Source 
The previous documentation was not accurate. It said that the length of
the error returned would be the length of the valid prefix. In case of
no valid prefix however the code will still return 1, contrary to the
documentation.
I fixed the documentation by adding the guarantee that the error length
will always be positive and removing the information about the valid
prefix as we might want to change the precise algorithm in the future.
This commit is contained in:
Johannes Weiss
2018-11-14 12:13:16 +00:00
parent e379ab9beb
commit 11b6bb3417
1 changed files with 1 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
stdlib/public/core/UnicodeParser.swift
View File

@@ -22,8 +22,7 @@ extension Unicode {
/// An encoding error was detected.
///
/// `length` is the number of underlying code units consumed by this
/// error (the length of the longest prefix of a valid encoding
/// sequence that could be recognized).
/// error, guaranteed to be greater than 0.
case error(length: Int)
@inlinable // FIXME(sil-serialize-all)