10000 Update doc-strings · nikicat/github3.py@33ea1eb · GitHub
[go: up one dir, main page]
Skip to content

Commit 33ea1eb

Browse files
sigmavirus24sigmavirus24
committed
Update doc-strings
Also update iter_pulls
1 parent 91293f5 commit 33ea1eb

File tree

2 files changed

+37
-6
lines changed

2 files changed

+37
-6
lines changed

‎github3/github.py

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -584,10 +584,15 @@ def iter_issues(self, filter='', state='', labels='', sort='',
584584
direction='', since=None, number=-1, etag=None):
585585
"""List all of the authenticated user's (and organization's) issues.
586586
587+
.. versionchanged:: 0.9.0
588+
589+
- The ``state`` parameter now accepts 'all' in addition to 'open'
590+
and 'closed'.
591+
587592
:param str filter: accepted values:
588593
('assigned', 'created', 'mentioned', 'subscribed')
589594
api-default: 'assigned'
590-
:param str state: accepted values: ('open', 'closed')
595+
:param str state: accepted values: ('all', 'open', 'closed')
591596
api-default: 'open'
592597
:param str labels: comma-separated list of label names, e.g.,
593598
'bug,ui,@high'
@@ -616,10 +621,15 @@ def iter_user_issues(self, filter='', state='', labels='', sort='',
616621
"""List only the authenticated user's issues. Will not list
617622
organization's issues
618623
624+
.. versionchanged:: 0.9.0
625+
626+
- The ``state`` parameter now accepts 'all' in addition to 'open'
627+
and 'closed'.
628+
619629
:param str filter: accepted values:
620630
('assigned', 'created', 'mentioned', 'subscribed')
621631
api-default: 'assigned'
622-
:param str state: accepted values: ('open', 'closed')
632+
:param str state: accepted values: ('all', 'open', 'closed')
623633
api-default: 'open'
624634
:param str labels: comma-separated list of label names, e.g.,
625635
'bug,ui,@high'
@@ -649,10 +659,15 @@ def iter_repo_issues(self, owner, repository, milestone=None,
649659
"""List issues on owner/repository. Only owner and repository are
650660
required.
651661
662+
.. versionchanged:: 0.9.0
663+
664+
- The ``state`` parameter now accepts 'all' in addition to 'open'
665+
and 'closed'.
666+
652667
:param str owner: login of the owner of the repository
653668
:param str repository: name of the repository
654669
:param int milestone: None, '*', or ID of milestone
655-
:param str state: accepted values: ('open', 'closed')
670+
:param str state: accepted values: ('all', 'open', 'closed')
656671
api-default: 'open'
657672
:param str assignee: '*' or login of the user
658673
:param str mentioned: login of the user

‎github3/repos/repo.py

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1307,8 +1307,14 @@ def iter_issues(self,
13071307
etag=None):
13081308
"""Iterate over issues on this repo based upon parameters passed.
13091309
1310+
.. versionchanged:: 0.9.0
1311+
1312+
The ``state`` parameter now accepts 'all' in addition to 'open'
1313+
and 'closed'.
1314+
13101315
:param int milestone: (optional), 'none', or '*'
1311-
:param str state: (optional), accepted values: ('open', 'closed')
1316+
:param str state: (optional), accepted values: ('all', 'open',
1317+
'closed')
13121318
:param str assignee: (optional), 'none', '*', or login name
13131319
:param str mentioned: (optional), user's login name
13141320
:param str labels: (optional), comma-separated list of labels, e.g.
@@ -1463,7 +1469,17 @@ def iter_pulls(self, state=None, head=None, base=None, sort='created',
14631469
direction='desc', number=-1, etag=None):
14641470
"""List pull requests on repository.
14651471
1466-
:param str state: (optional), accepted values: ('open', 'closed')
1472+
.. versionchanged:: 0.9.0
1473+
1474+
- The ``state`` parameter now accepts 'all' in addition to 'open'
1475+
and 'closed'.
1476+
1477+
- The ``sort`` parameter was added.
1478+
1479+
- The ``direction`` parameter was added.
1480+
1481+
:param str state: (optional), accepted values: ('all', 'open',
1482+
'closed')
14671483
:param str head: (optional), filters pulls by head user and branch
14681484
name in the format ``user:ref-name``, e.g., ``seveas:debian``
14691485
:param str base: (optional), filter pulls by base branch name.
@@ -1481,7 +1497,7 @@ def iter_pulls(self, state=None, head=None, base=None, sort='created',
14811497
"""
14821498
url = self._build_url('pulls', base_url=self._api)
14831499
params = {}
1484-
if state and state.lower() in ('open', 'closed'):
1500+
if state and state.lower() in ('all', 'open', 'closed'):
14851501
params['state'] = state.lower()
14861502
params.update(head=head, base=base, sort=sort, direction=direction)
14871503
self._remove_none(params)

0 commit comments

Comments
 (0)
0