[stdlib] Revise documentation for string-related types & protocols #2644
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
This documentation revision covers a large number of types & protocols: String, its views and their indices, the Unicode codec types and protocol, as well as Character, UnicodeScalar, and StaticString, among others. This also includes a few small changes across the standard library for consistency. Cherry-picked and merged from 44b2d56
In addition to a new test fixture for 'SourceKit/DocSupport/ doc_clang_module.swift', this removes the check for an ASCII-only generated standard library interface from 'SourceKit/InterfaceGen/ gen_stdlib.swift'. Cherry-picked from dee12dc
Member
Author
|
@swift-ci Please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What's in this pull request?
This documentation revision covers a large number of types & protocols:
String, its views and their indices, the Unicode codec types and protocol, as well asCharacter,UnicodeScalar, andStaticString, among others.This also includes a few small changes across the standard library for consistency and a new test fixture to match the updated documentation.
Finally, this turns off the test requiring that the standard library generated interface be ASCII-only—the new
Stringdocumentation contains a fair amount of non-ASCII text to demonstrate the features of Swift's string system.Resolved bug number: n/a
Before merging this pull request to apple/swift repository:
Triggering Swift CI
The swift-ci is triggered by writing a comment on this PR addressed to the GitHub user @swift-ci. Different tests will run depending on the specific comment that you use. The currently available comments are:
Smoke Testing
Validation Testing
Note: Only members of the Apple organization can trigger swift-ci.