Docs: Change index.rst example to use followers_of

sigmavirus24 / github3.py

Hi, I'm a library for interacting with GItHub's REST API in a convenient and ergonomic way. I work on Python 3.6+.

https://github3.readthedocs.io

BSD 3-Clause "New" or "Revised" License

1.21k stars 404 forks source link

Docs: Change index.rst example to use followers_of #1046

Closed gunnarx closed 3 years ago

gunnarx commented 3 years ago

The last line in the initial example fails before this change. The intention was probably to demonstrate the followers_of() function, instead of followers()

(Sorry, I ignored your bug-report instructions in this PR. The change should be self-explanatory I imagine).

A side note: Filling the array for the 28000 followers of kennethreitz using the API seemed to take a substantial amount of time (?), so maybe another example would be a good idea.

gunnarx commented 3 years ago

Update: Added name to AUTHORS.rst as requested in CONTRIBUTING