Merge pull request #1670 from python-gitlab/jlvillal/merge_requests_api

nejch · web-flow · commit 4ab9e9231bdd · 2021-11-06T10:24:19.000+01:00
docs: add links to the GitLab API docs
diff --git a/gitlab/v4/objects/merge_requests.py b/gitlab/v4/objects/merge_requests.py
@@ -1,3 +1,8 @@
+"""
+GitLab API:
+https://docs.gitlab.com/ee/api/merge_requests.html
+https://docs.gitlab.com/ee/api/merge_request_approvals.html
+"""
 from gitlab import cli
 from gitlab import exceptions as exc
 from gitlab import types
@@ -253,6 +258,8 @@ def approve(self, sha=None, **kwargs):
         Raises:
             GitlabAuthenticationError: If authentication is not correct
             GitlabMRApprovalError: If the approval failed
+
+        https://docs.gitlab.com/ee/api/merge_request_approvals.html#approve-merge-request
         """
         path = f"{self.manager.path}/{self.get_id()}/approve"
         data = {}
@@ -273,6 +280,8 @@ def unapprove(self, **kwargs):
         Raises:
             GitlabAuthenticationError: If authentication is not correct
             GitlabMRApprovalError: If the unapproval failed
+
+        https://docs.gitlab.com/ee/api/merge_request_approvals.html#unapprove-merge-request
         """
         path = f"{self.manager.path}/{self.get_id()}/unapprove"
         data = {}
