iOS Documentation Revamp #650
Conversation
*Changed PFObject fetch example to use fetchInBackground and updated documentation to reflect example used. *Removed Local Datastore documentation instructing to unnecessarily add a dynamic library.
*Removed unnecessary instructions to manually add dynamic library *Updated Objective-C AppDelegate example to be more in line with the Swift example. *Added documentation to include Parse.enableLocalDatastore() *Updating examples for Retrieving Objects in Local Data Store to use PFObjectResultBlock rather than a BFTask completion in order to reduce confusion.
*Updated Swift and Objective-C examples to reflect current version of Parse iOS SDK and language changes as well as to make more consistent between language examples. *Updated verbiage document wide to improve comprehention and remove documentation that is no longer relevant or helpful by todays standard.
*Removed irrelevant documention for deleting individual relational pointer data. *Replaced basic single line "deleteInBackground" example in favor of demonstrating multi-object deletion using PFObject's static deleteAllInBackground:block function.
Co-Authored-By: Tom Fox <tomfox@surprises.io>
Co-Authored-By: Tom Fox <tomfox@surprises.io>
Co-Authored-By: Tom Fox <tomfox@surprises.io>
Co-Authored-By: Tom Fox <tomfox@surprises.io>
Co-Authored-By: Tom Fox <tomfox@surprises.io>
|
I'm so sorry for missing some of this dumb little things. I guess after spending 5+ hours after it last night I got a little sloppy. Theres just so much that needs to be done. |
|
No worries, it happens to everyone, that’s what the review process is for! I’m just happy that you’re making the effort 🙂 |
|
I’ll give this a full review tomorrow. |
|
I just thought of something last night that I think needs to be addressed sooner than later. The Swift documentation has strayed quite a ways from Objective-C in terms of function names and conventions. Which was inevitable because of how different the languages are. However, all referenced function names in the documentation text is in Objective-C. My thought process is that most of those that still use Objective-C probably aren't the kind who would need to spend much time reading documentation to begin with. My goal is to do a section or two a day till all the core documentation corrections have been completed. So, if there ever was a time to start showing preference to Swift in the documentation, now would be the time to do it. Your thoughts? Also, would you prefer bite sized chunks to review or does submitting a lot of changes at once work for you? |
|
I would agree on showing preference to Swift. It's probably a bit easier if you submit separate PRs for different sections for example, however the GitHub UI makes it fairly easy to review large PRs so I'm not hugely bothered. |
|
Perfect. I end up having to rewrite most function names anyway so I'll just start doing swift. I can start making branches on my fork and start doing individual sections as pull requests. Also might help with consistency. Once we have this all done I might start go back and do the tedious task of making the Swift example default. |
Co-Authored-By: Tom Fox <tomfox@surprises.io>
Co-Authored-By: Tom Fox <tomfox@surprises.io>
Co-Authored-By: Tom Fox <tomfox@surprises.io>
Co-Authored-By: Tom Fox <tomfox@surprises.io>
Co-Authored-By: Tom Fox <tomfox@surprises.io>
|
@noobs2ninjas this is looking good to me now, but I'd like to pull down the changes and check it all in the local host which I will do tomorrow. @dplewis I know you're not huge on the iOS SDK but I would appreciate another set of eyes if you could give this a once over? |
|
Thanks for taking the time to improve the docs! |
* commit 'e129790ed587819ecfcaed59fc7ff90ec6ffcfa1': (84 commits) Add `cascadeSave` option in ParseObject to JS docs (parse-community#664) Update apple sign in documentation (parse-community#662) Bump mixin-deep from 1.3.1 to 1.3.2 (parse-community#670) Update GraphQL docs with latest changes (parse-community#669) remove a bunch of parse cloud references (parse-community#654) docs: fixed examples for pipeline in aggregation (parse-community#661) Add beta notice to the GraphQL Guide (parse-community#659) iOS Documentation Revamp (parse-community#650) Fix doc for creating a subscription in javascript (parse-community#658) GraphQL Customisation (parse-community#652) added PhantAuth authData docs (parse-community#655) Fix typo in keys.md (parse-community#656) Fix typo in cloud-code.md (parse-community#657) add reference to afterFind, add more detail on predefined classes (parse-community#653) Add `keys` and `excludeKeys` options to REST docs (parse-community#649) document push type and priority keys for notifications (parse-community#639) Documentation for Sign In With Apple (parse-community#648) Documentation for isDataAvailable (parse-community#647) Remove line for 3.x (parse-community#646) Add documentation for query.withCount (parse-community#645) ...
I'd like to leave this pull request open and keep adding to it and have some open communication about the updates unless someone has a better Idea of how to keep track of all the changes needing be made.