Skip to content

Commit e65e0b8

Browse files
committed
Improve the documentation per @esacteskab's review
1 parent 9372986 commit e65e0b8

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

github3/api.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -385,13 +385,17 @@ def search_repositories(query, sort=None, order=None, per_page=None,
385385
whether forked repositories should be included in the results at
386386
all.
387387
- ``created`` or ``pushed`` Filters repositories based on times of
388-
creation, or when they were last updated.
388+
creation, or when they were last updated. Format: ``YYYY-MM-DD``.
389+
Examples: ``created:<2011``, ``pushed:<2013-02``,
390+
``pushed:>=2013-03-06``
389391
- ``user`` or ``repo`` Limits searches to a specific user or
390392
repository.
391393
- ``language`` Searches repositories based on the language they're
392394
written in.
393395
- ``stars`` Searches repositories based on the number of stars.
394396
397+
For more information about these qualifiers, see: http://git.io/4Z8AkA
398+
395399
:param str query: (required), a valid query as described above, e.g.,
396400
``tetris language:assembly``
397401
:param str sort: (optional), how the results should be sorted;

github3/github.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1002,13 +1002,17 @@ def search_repositories(self, query, sort=None, order=None,
10021002
whether forked repositories should be included in the results at
10031003
all.
10041004
- ``created`` or ``pushed`` Filters repositories based on times of
1005-
creation, or when they were last updated.
1005+
creation, or when they were last updated. Format: ``YYYY-MM-DD``.
1006+
Examples: ``created:<2011``, ``pushed:<2013-02``,
1007+
``pushed:>=2013-03-06``
10061008
- ``user`` or ``repo`` Limits searches to a specific user or
10071009
repository.
10081010
- ``language`` Searches repositories based on the language they're
10091011
written in.
10101012
- ``stars`` Searches repositories based on the number of stars.
10111013
1014+
For more information about these qualifiers, see: http://git.io/4Z8AkA
1015+
10121016
:param str query: (required), a valid query as described above, e.g.,
10131017
``tetris language:assembly``
10141018
:param str sort: (optional), how the results should be sorted;

0 commit comments

Comments
 (0)