github3.py icon indicating copy to clipboard operation
github3.py copied to clipboard

Incorrect documentation for listing gists

Open Aran-Fey opened this issue 3 years ago • 0 comments

The documentation for gists() says:

Retrieve the authenticated user’s gists.

But in reality, it returns other people's gists:

import github3

gh = github3.login(username='Aran-Fey', password='foobar')

for gist in gh.gists(number=5):
    print(gist, gist.owner)

# 92bd5c227fecf9ce02d58348cb0ce0e8 GrahamcOfBorg
# c1cae7cbc7d3a8403b5b11a8e772d4b0 ballerina-github-bot
# a4e87b5ed144ae632bcac58241da5dcc ballerina-github-bot
# 4327d03c7539129ce0849ac0f4335031 ballerina-github-bot
# 1e35a6aba7d4517e55238866a7045004 ballerina-github-bot

Also, in this section you show off a function named iter_gists(), which does not exist.

Aran-Fey avatar Jan 29 '22 08:01 Aran-Fey