8000 docs: add links to the GitLab API docs · python-gitlab/python-gitlab@fa56b99 · GitHub
[go: up one dir, main page]

Skip to content

Commit fa56b99

Browse files
docs: add links to the GitLab API docs
Add links to the GitLab API docs for merge_requests.py as it contains code which spans two different API documentation pages.
1 parent 7925c90 commit fa56b99

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

gitlab/v4/objects/merge_requests.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
"""
2+
GitLab API:
3+
https://docs.gitlab.com/ee/api/merge_requests.html
4+
https://docs.gitlab.com/ee/api/merge_request_approvals.html
5+
"""
6+
import gitlab
17
from gitlab import cli
28
from gitlab import exceptions as exc
39
from gitlab import types
@@ -253,6 +259,8 @@ def approve(self, sha=None, **kwargs):
253259
Raises:
254260
GitlabAuthenticationError: If authentication is not correct
255261
GitlabMRApprovalError: If the approval failed
262+
263+
https://docs.gitlab.com/ee/api/merge_request_approvals.html#approve-merge-request
256264
"""
257265
path = f"{self.manager.path}/{self.get_id()}/approve"
258266
data = {}
@@ -273,6 +281,8 @@ def unapprove(self, **kwargs):
273281
Raises:
274282
GitlabAuthenticationError: If authentication is not correct
275283
GitlabMRApprovalError: If the unapproval failed
284+
285+
https://docs.gitlab.com/ee/api/merge_request_approvals.html#unapprove-merge-request
276286
"""
277287
path = f"{self.manager.path}/{self.get_id()}/unapprove"
278288
data = {}

0 commit comments

Comments
 (0)
0