JuliaWeb / JuliaWeb/GitForge.jl

Needs example of using paginate, and explination that it is required

Open
#17 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Julia
Stars
13
Forks
13
PR merge metrics
No merged PRs in 30d

Description

At no point in the docs does it mention that `@paginate` is basically required to be used for all calls that might return more than one thing.

Possibly we should actually always return a iterator like `@paginate` does .
But right now we don't.

I was wondering why `get_pull_requests(forge, project_id)` was only returning 20 things even though i knew their are like 100 pull reqests on that repo.
Docs for `get_pull_requests` never mentioned `@paginate`.
No example of it being used was anywhere,
but I tried
`@paginate get_pull_requests(forge, project_id)`
and that returned all my pull requests.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.