Events documentation and per_page param

[wayofthepie]

What is the current behavior?

The docs for the Events API says the following:

Events support pagination, however the per_page option is unsupported. The fixed page size is 30 items. Fetching up to ten pages is supported, for a total of 300 events. For information, see "Traversing with pagination."

However, each of the API's does document a per_page parameter and it does seem to work fine:

$ curl -s https://api.github.com/repos/wayofthepie/ctlogs-cli/events?per_page=12 | jq '. | length'
12

What changes are you suggesting?

It seems like the section mentioning per_page is unsupported should be removed, if per_page is indeed meant to work for the Events API.

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[janiceilene]

Thanks for opening an issue @wayofthepie! I'll triage this for the right team to take a look 👀

[skedwards88]

@wayofthepie Thanks for catching this discrepancy! You are correct that this paragraph should be removed. ✨ You or anyone else is welcome to open a PR to address this issue.

[KrKeshav09]

I am new with this could I able to contribute in this work as I am still learning

[janiceilene]

@KrKeshav09 Take a look at the contributing.md to learn how to contribute in this repo. You can open a discussion if you have any questions or check out issues with the help wanted label. ✨

[vivekshotti]

Please check PR #4362 . I have done the required changes. Open to suggestions / comments.