@@ -8,60 +8,66 @@ class References(Service):
88 """Consume `References API <http://developer.github.com/v3/git/refs/>`_"""
99
1010 def get (self , ref , user = None , repo = None ):
11- """Get a reference.
11+ """ Get a reference
1212
13- .. note::
14- Remember that branch references look like "heads/<branch_name>"
15-
16- :param str ref: the name of the reference to get
13+ :param str ref: The name of the reference to get
1714 :param str user: Username
1815 :param str repo: Repository
1916
17+ .. note::
18+ Remember :ref:`config precedence`
19+
20+ .. note::
21+ Remember that branch references look like "heads/<branch_name>"
2022 """
21- return self ._get (
22- self .make_request ('git_data.references.get' , ref = ref , user = user ,
23- repo = repo )
24- )
23+ request = self .make_request ('git_data.references.get' , ref = ref ,
24+ user = user , repo = repo )
25+ return self ._get (request )
2526
2627 def list (self , namespace = '' , user = None , repo = None ):
27- """List all the references
28+ """ List all the references
2829
2930 :param str namespace: Limit the request to a particular type of
3031 reference. For example, ``heads`` or ``tags``.
3132 :param str user: Username
3233 :param str repo: Repository
34+ :returns: A :doc:`result`
3335
36+ .. note::
37+ Remember :ref:`config precedence`
3438 """
35- return self ._get (
36- self . make_request ( 'git_data.references.list' , user = user , repo = repo )
37- )
39+ request = self .make_request ( 'git_data.references.list' , user = user ,
40+ repo = repo , namespace = namespace )
41+ return self . _get_result ( request )
3842
39- def create (self , body , user = None , repo = None ):
40- """Create a reference
43+ def create (self , data , user = None , repo = None ):
44+ """ Create a reference
4145
42- :param dict body: Data describing the reference to create
46+ :param dict data: Input. See `github refs doc`_
4347 :param str user: Username
4448 :param str repo: Repository
4549
50+ .. note::
51+ Remember :ref:`config precedence`
4652 """
47- return self ._post (
48- self .make_request ('git_data.references.create' , body = body ,
49- user = user , repo = repo )
50- )
53+ request = self .make_request ('git_data.references.create' , body = data ,
54+ user = user , repo = repo )
55+ return self ._post (request )
5156
52- def update (self , ref , body , user = None , repo = None ):
53- """Update an existing reference
57+ def update (self , ref , data , user = None , repo = None ):
58+ """ Update an existing reference
5459
5560 :param str ref: The SHA of the reference to update
56- :param dict body: Data to update the reference with
61+ :param dict data: Input. See `github refs doc`_
5762 :param str user: Username
5863 :param str repo: Repository
5964
65+ .. note::
66+ Remember :ref:`config precedence`
6067 """
61- return self ._patch (
62- self .make_request ('git_data.references.update' , ref = ref , body = body ,
63- user = user , repo = repo )
64- )
68+ request = self .make_request ('git_data.references.update' , ref = ref ,
69+ body = data , user = user , repo = repo )
70+ return self ._patch (request )
6571
6672 def delete (self , ref , user = None , repo = None ):
6773 """Delete a reference
@@ -70,8 +76,9 @@ def delete(self, ref, user=None, repo=None):
7076 :param str user: Username
7177 :param str repo: Repository
7278
79+ .. note::
80+ Remember :ref:`config precedence`
7381 """
74- return self ._delete (
75- self .make_request ('git_data.references.delete' , ref = ref , user = user ,
76- repo = repo )
77- )
82+ request = self .make_request ('git_data.references.delete' , ref = ref ,
83+ user = user , repo = repo )
84+ return self ._delete (request )
0 commit comments