Visitar URL original
Add bare bones documentation · goodwillcoding/github3.py@8a8ff62 · GitHub
Skip to content

Commit 8a8ff62

Browse files
sigmavirus24sigmavirus24
committed
Add bare bones documentation
Document Search Result objects [ci skip]
1 parent 4604f7c commit 8a8ff62

2 files changed

Lines changed: 27 additions & 1 deletion

File tree

‎docs/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,11 @@ Modules
7272
git
7373
github
7474
issues
75-
legacy
7675
models
7776
orgs
7877
pulls
7978
repos
79+
search_structs
8080
structs
8181
users
8282

‎docs/search_structs.rst‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. module:: github3
2+
.. module:: github3.search
3+
4+
Search Structures
5+
=================
6+
7+
These classes are meant to expose the entirety of an item returned as a search
8+
result by GitHub's Search API.
9+
10+
Objects
11+
-------
12+
13+
.. autoclass:: CodeSearchResult
14+
:members:
15+
16+
17+
.. autoclass:: IssueSearchResult
18+
:members:
19+
20+
21+
.. autoclass:: RepositorySearchResult
22+
:members:
23+
24+
25+
.. autoclass:: UserSearchResult
26+
:members:

0 commit comments

Comments
 (0)