documentation update and re-organization#381
Merged
heckj merged 17 commits intoapple:mainfrom Nov 3, 2025
Merged
Conversation
- added organization for methods in all public types (curation). - reworded abstracts to not use code voice or symbols. - revised some abstracts to present a single sentence. - reworded some parameters and article content to remove the use of passive voice or future tense.
Co-authored-by: Honza Dvorsky <honza@apple.com>
Co-authored-by: Honza Dvorsky <honza@apple.com>
Co-authored-by: Honza Dvorsky <honza@apple.com>
Co-authored-by: Honza Dvorsky <honza@apple.com>
Co-authored-by: Honza Dvorsky <honza@apple.com>
… - incorrect comment copied into place
czechboy0
approved these changes
Oct 27, 2025
Contributor
czechboy0
left a comment
There was a problem hiding this comment.
One more set of suggestions, but lgtm otherwise
FranzBusch
approved these changes
Oct 27, 2025
Member
FranzBusch
left a comment
There was a problem hiding this comment.
Overall this LGTM. I left one smaller NIT.
Co-authored-by: Franz Busch <privat@franz-busch.de>
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
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.
Provide organization (aka curation) and abstracts for all of the public types in the library.
Motivation:
Updates to the documentation to fill in the missing abstracts for the provided types, updating the language to follow Apple developer content guidelines, and fixing smaller typos and grammar issues.
Modifications:
Curation files added to provide organization for public types, ordering the content to align with the narrative content provided earlier. Updating API comments, adding abstracts and parameters where missing, and moving some of the getting started content that was previously in the main index into a separate article.
Result:
starting point
Updated: