Skip to content

Commit

Permalink
Convert paginator note to a tip admonition
Browse files Browse the repository at this point in the history
Co-authored-by: VioletM <[email protected]>
  • Loading branch information
burnash and VioletM authored May 7, 2024
1 parent fb4a2b0 commit 168cb8a
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/website/docs/general-usage/http/rest-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,9 @@ for page in client.paginate("/posts"):
print(page)
```

:::tip
If `paginator` is not specified, the `paginate()` method will attempt to automatically detect the pagination mechanism used by the API. If the API uses a standard pagination mechanism like having a `next` link in the response's headers or JSON body, the `paginate()` method will handle this automatically. Otherwise, you can specify a paginator object explicitly or implement a custom paginator.
:::

### PageData

Expand Down

0 comments on commit 168cb8a

Please sign in to comment.