Add DocC documentation catalogs to Essentials, Internationalization, and Preview modules. #283
Conversation
This file contains 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
itingliu
reviewed
Nov 9, 2023
| * JSON encoding and decoding. | ||
| * A ``URL`` type for network and local resources. | ||
|
|
||
| Foundation Essentials provides these features without system dependencies, so developers can count on consistent behavior, regardless of platform. |
There was a problem hiding this comment.
I'm not sure if this "without system dependencies" is entirely correct. We still use other libraries. It's just that FoundationEssentials abstracts away the underlying dependencies and chooses the one depending on the platform for developers, so they don't need to worry about platform check.
There was a problem hiding this comment.
I was trying to include this concept from the original announcement:
a new FoundationEssentials package will provide the most important types in Foundation with no system dependencies to help accomplish this.
But yeah, without the context of the rest of that announcement, there are lots of ways to read "without system dependencies".
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.
This PR is the first step of providing DocC-based documentation for Swift Foundation.
This PR adds
.doccdirectories to FoundationEssentials, FoundationInternationalization, and Foundation (the top-level superset module). Along with providing an overview of each module, this PR performs an initial curation of top-level symbols into topic groups.It doesn't curate all symbols in all types; that can come later when each type is documented. However, some types (such as
AttributedStringandPredicate) do get an initial curation for the sake of giving their helper types someplace to go.Generate documentation with Xcode's "Product -> Build Documentation" menu item, or via the
xcodebuildcommand-line:On other platforms, you can use the Swift-DocC Plugin to generate documentation.