##// END OF EJS Templates
docs: update API documentation
marcink -
r3000:d3d62463 default
parent child Browse files
Show More
@@ -83,7 +83,7 b' comment_pull_request'
83 create_pull_request
83 create_pull_request
84 -------------------
84 -------------------
85
85
86 .. py:function:: create_pull_request(apiuser, source_repo, target_repo, source_ref, target_ref, title, description=<Optional:''>, reviewers=<Optional:None>)
86 .. py:function:: create_pull_request(apiuser, source_repo, target_repo, source_ref, target_ref, title=<Optional:''>, description=<Optional:''>, description_renderer=<Optional:''>, reviewers=<Optional:None>)
87
87
88 Creates a new pull request.
88 Creates a new pull request.
89
89
@@ -104,10 +104,14 b' create_pull_request'
104 :type source_ref: str
104 :type source_ref: str
105 :param target_ref: Set the target ref name.
105 :param target_ref: Set the target ref name.
106 :type target_ref: str
106 :type target_ref: str
107 :param title: Set the pull request title.
107 :param title: Optionally Set the pull request title, it's generated otherwise
108 :type title: str
108 :type title: str
109 :param description: Set the pull request description.
109 :param description: Set the pull request description.
110 :type description: Optional(str)
110 :type description: Optional(str)
111 :type description_renderer: Optional(str)
112 :param description_renderer: Set pull request renderer for the description.
113 It should be 'rst', 'markdown' or 'plain'. If not give default
114 system renderer will be used
111 :param reviewers: Set the new pull request reviewers list.
115 :param reviewers: Set the new pull request reviewers list.
112 Reviewer defined by review rules will be added automatically to the
116 Reviewer defined by review rules will be added automatically to the
113 defined list.
117 defined list.
@@ -368,7 +372,7 b' merge_pull_request'
368 update_pull_request
372 update_pull_request
369 -------------------
373 -------------------
370
374
371 .. py:function:: update_pull_request(apiuser, pullrequestid, repoid=<Optional:None>, title=<Optional:''>, description=<Optional:''>, reviewers=<Optional:None>, update_commits=<Optional:None>)
375 .. py:function:: update_pull_request(apiuser, pullrequestid, repoid=<Optional:None>, title=<Optional:''>, description=<Optional:''>, description_renderer=<Optional:''>, reviewers=<Optional:None>, update_commits=<Optional:None>)
372
376
373 Updates a pull request.
377 Updates a pull request.
374
378
@@ -382,6 +386,9 b' update_pull_request'
382 :type title: str
386 :type title: str
383 :param description: Update pull request description.
387 :param description: Update pull request description.
384 :type description: Optional(str)
388 :type description: Optional(str)
389 :type description_renderer: Optional(str)
390 :param description_renderer: Update pull request renderer for the description.
391 It should be 'rst', 'markdown' or 'plain'
385 :param reviewers: Update pull request reviewers list with new value.
392 :param reviewers: Update pull request reviewers list with new value.
386 :type reviewers: Optional(list)
393 :type reviewers: Optional(list)
387 Accepts username strings or objects of the format:
394 Accepts username strings or objects of the format:
General Comments 0
You need to be logged in to leave comments. Login now