- 
                Notifications
    
You must be signed in to change notification settings  - Fork 329
 
documentation update and re-organization #381
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @heckj, a few comments
Co-authored-by: Honza Dvorsky <[email protected]>
Co-authored-by: Honza Dvorsky <[email protected]>
Co-authored-by: Honza Dvorsky <[email protected]>
Co-authored-by: Honza Dvorsky <[email protected]>
Co-authored-by: Honza Dvorsky <[email protected]>
… - incorrect comment copied into place
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One more set of suggestions, but lgtm otherwise
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall this LGTM. I left one smaller NIT.
Co-authored-by: Franz Busch <[email protected]>
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: