Description about the default value of the per_page option

[ybiquitous]

Hi there,

I found the difference between README and the actual code, about the default per_page value.

REAMDE: 30

Default results from the GitHub API are 30, if you wish to add more you must do so during Octokit configuration.

https://github.com/octokit/octokit.rb/blob/c5037e4abbf154b2123019e8d109e24490bf1be5/README.md#default-results-per_page

Code: 100

octokit.rb/lib/octokit/connection.rb

Line 81 in 116ddac

opts[:query][:per_page] ||= @per_page || (@auto_paginate ? 100 : nil)

It seems that the README description is incorrect, but what do you think?
Thanks.

[tarebyte]

@ybiquitous the actual GitHub API defaults to 30 if we don't pass in a per_page query parameter. It looks like we set it in the client as 100 if we are auto paginating so that we make fewer requests.

I'm not sure I see the inconsistency here.

[ybiquitous]

Surely, there is no inconsistency.
But the behavior, which per_page is 100 if auto_paginate is set, seems undocumented and may confuse users (like me 😅 ).

So, what about documenting that behavior on this README?

[github-actions]

👋 Hey Friends, this issue has been automatically marked as stale because it has no recent activity. It will be closed if no further activity occurs. Please add the Status: Pinned label if you feel that this issue needs to remain open/active. Thank you for your contributions and help in keeping things tidy!