[stdlib] Improve documentation for the various "String from C-string" initializers #71224
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
glessard
commented
Jan 29, 2024
|
@swift-ci please test |
1 similar comment
|
@swift-ci please test |
These were all on |
grynspan
requested changes
Jan 30, 2024
These functions were the odd ones out in not using `encoding` for this parameter label. Harmonizing this term will also make the documentation more consistent.
glessard
force-pushed
the
rdar121395821
branch
from
b43a446 to
e10899e
Compare
|
@swift-ci please test |
grynspan
approved these changes
Feb 2, 2024
grynspan
added a commit
to swiftlang/swift-testing
that referenced
this pull request
Feb 5, 2024
The overload of `String.init(validatingUTF8:)` that takes an array of `CChar` values rather than a pointer is not really meant to be used. The overload exists for the benefit of the type checker so that future compilers can warn when a developer misuses the implicit array-to-pointer conversion. This PR changes our wrapper around `sysctlbyname()` to avoid producing a temporary `[CChar]`, thus dodging the problem. See also swiftlang/swift#71224. Resolves rdar://122198850.
2 tasks
grynspan
added a commit
to swiftlang/swift-testing
that referenced
this pull request
Feb 5, 2024
The overload of `String.init(validatingUTF8:)` that takes an array of `CChar` values rather than a pointer is not really meant to be used. The overload exists for the benefit of the type checker so that future compilers can warn when a developer misuses the implicit array-to-pointer conversion. This PR changes our wrapper around `sysctlbyname()` to avoid producing a temporary `[CChar]`, thus dodging the problem. See also swiftlang/swift#71224. Resolves rdar://122198850.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@natecook1000 pointed out missing documentation in #68423 (comment)
This PR adds doc-comments to the
Array-taking overloads of the C-string conversion initializers. In the cases where there is a more appropriate Swift spelling, they are now deprecated in Swift 6, with a message pointing to the better alternative both in the deprecation declaration and in the doc-comment.Other minor wording improvements included.
Addresses rdar://121395821