Skip to content
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

[2/2] Update ApolloPagination usage docs for a 0.2.0 release #317

Merged
merged 5 commits into from
Apr 22, 2024

Conversation

Iron-Ham
Copy link
Contributor

@Iron-Ham Iron-Ham commented Mar 25, 2024

Depends on #316
Depends on #292

__

This pull request updates the usage guide related to the changes made in #292.

Note that I cannot create or point at a Pagination-0.2.0 branch (nor can I point at #316 and still have this PR appear in this repo), but this would be part 2 of 2 for updating the docs for a 0.2.0 release. To that end, I recommend ignoring the total diff and looking at the relevant commit of this pull request.

Perhaps something to consider for general docs after 0.2.0 is out: we should include usage docs for the AsyncGraphQLQueryPager, as we make mention of it, but never showcase its usage.

Copy link

netlify bot commented Mar 25, 2024

👷 Deploy request for apollo-ios-docc pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 02b30f1

Copy link

netlify bot commented Mar 25, 2024

👷 Deploy request for eclectic-pie-88a2ba pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 02b30f1

Copy link
Contributor

@AnthonyMDev AnthonyMDev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do any of the code samples in the docs need to be updated for these changes?

@Iron-Ham
Copy link
Contributor Author

Iron-Ham commented Mar 25, 2024

No. I think the fact that they don't implies the need for more robust docs. Adding it to my to-do list ☺️

EDIT:

  • Found that the existing docs made references to callbacks that weren't there (although, existing docs never used them).
  • Added some extra notes on AsyncGraphQLQueryPager

I think one of the big impediments is likely a good usage sample for both UIKit and SwiftUI. I have one up for SwiftUI here, but ideally I'd want to snap away all of the known issues prior to pushing for an official sample or going 1.0. The need for a secondary trigger... is one that I'd have to spend a lot of time thinking about – and I wonder if that's something that you'd be open to discussing in a Zoom chat @AnthonyMDev? It's a tough one to contend with, as the current API design is meant to prevent the issue of fetching a next page based on cached data – which is good.

Perhaps a mechanism for queuing one pagination operation may be a good thing, as @mapy1874 alluded to in apollographql/apollo-ios#3349. I can take some time tomorrow to noodle on a potential solution.

@AnthonyMDev AnthonyMDev merged commit b28383f into apollographql:main Apr 22, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants