GravatarUI docc bundle #229
Conversation
|
I remember Beau asking somewhere to be removed from https://docs.gravatar.com/general/images/, might be worth changing the default screenshots here. |
| // 3. Get the instance of a ProfileView: | ||
| let profileView = ProfileView() | ||
| // 4. Set the profile to the view: | ||
| profileView.update(with: profile) |
There was a problem hiding this comment.
Kind of related to this documentation, as a newbie Swift dev, I'd like to know how you handle errors here :)
We're changing the network API on Android and had a discussion about errors on this PR: https://github.com/Automattic/Gravatar-SDK-Android/pull/130/files#r1579020468
There was a problem hiding this comment.
We will have some more-in-detail implementation examples in other pages. I plan a Getting Started page for example, and a tutorial for making lists of profile cards. Also probably another for the presentation styles.
This one is meant to be only introductory 👍
But still from this example, if someone copy paste this code, error handling will be enforced by the compiler from the try clause. So, though it's not explicit, it won't be missed.
let profile = try await service.fetch(with: .email("user@email.com"))
There was a problem hiding this comment.
In Swift all errors are like checked exceptions so the compiler forces you to handle them. However, they are not declared in the method signature(you only add "throws"), so if you want to handle a specific error you need to do a type casting first. :( And you never know what sorts of errors will be thrown just by looking at the signature. So to compensate for that we try to keep a catalog of errors that we are throwing, that way 3rd party devs can have an idea.
There was a problem hiding this comment.
👍 thanks for the explanation!
Oh that's good to know. But yes, the idea is to change it for an account of a not-real person. |
|
I think we can generate one from random generator to unblock this PR. It would be good to have these changes in trunk since we might want to add more docs at the top of this. We can always update our snapshots in the future. WDYT? @etoledom |
Cool! Let's do that |
|
I've chosen an AI generated image and description, plus personal information from the simulator's contact app. |
Good choice. This is pretty familiar for any iOS dev. |
Closes #155
Description
This PR implements the basics to add docs and pages to GravatarUI using Swfit-docc.
I've added a new snapshot test case to generate an example profile view to use in the docs. For now I've decided to use the same account that is used in https://docs.gravatar.com/general/profile/ , though this this is subject to change. More important than the account itself, is to check the strategy chosen to generate and use these snapshots.
I've created a make command to copy the snapshots from the test target to the docs bundle:
make update-example-snapshotsThis is not hook to anything yet, so it need to be triggered manually.
Sadly in SPM we don't have a way to trigger post-test commands.
We can add a post-action to the test target in the Xcode scheme, but it's a local setting.
Testing Steps