8000 initial thoughts, the end goal is to have an example per section/meth… · krxsky/github3.py@fba67af · GitHub
[go: up one dir, main page]

8000
Skip to content

Commit fba67af

Browse files
committed
initial thoughts, the end goal is to have an example per section/method per GH's doc hierarchy
1 parent 8878a0c commit fba67af

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/gh/users.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,27 @@ If you want a list of all users in order they signed up to GitHub, use:
3939
.. autofunction:: github3.iter_all_users
4040
:noindex:
4141

42+
43+
An Example:
44+
45+
.. code-block:: python
46+
47+
In [1]: import github3
48+
49+
In [2]: users = github3.iter_all_users()
50+
51+
In [3]: type(users)
52+
Out[3]: github3.structs.GitHubIterator
53+
54+
In [4]: user = users.next()
55+
56+
In [5]: type(user)
57+
Out[5]: github3.users.User
58+
59+
In [6]: user.html_url
60+
Out[6]: u'https://github.com/mojombo'
61+
62+
63+
64+
65+

0 commit comments

Comments
 (0)
0