summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJohn Villalovos <john@sodarock.com>2022-06-25 06:29:30 -0700
committerGitHub <noreply@github.com>2022-06-25 15:29:30 +0200
commit5583eaa108949386c66290fecef4d064f44b9e83 (patch)
treefdf976d8a41fb6c164df1f255d2b43f8096a2bff /docs
parenta825844e1f6a5aa7c35df90f1891d2ef91ffe4a8 (diff)
downloadgitlab-5583eaa108949386c66290fecef4d064f44b9e83.tar.gz
docs(api): fix incorrect docs for merge_request_approvals (#2094)
* docs(api): fix incorrect docs for merge_request_approvals The `set_approvers()` method is on the `ProjectApprovalManager` class. It is not part of the `ProjectApproval` class. The docs were previously showing to call `set_approvers` using a `ProjectApproval` instance, which would fail. Correct the documentation. This was pointed out by a question on the Gitter channel. Co-authored-by: Nejc Habjan <nejc.habjan@siemens.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/gl_objects/merge_request_approvals.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/gl_objects/merge_request_approvals.rst b/docs/gl_objects/merge_request_approvals.rst
index 661e0c1..86659de 100644
--- a/docs/gl_objects/merge_request_approvals.rst
+++ b/docs/gl_objects/merge_request_approvals.rst
@@ -58,7 +58,10 @@ Change project-level or MR-level MR approvals settings::
p_mras.approvals_before_merge = 2
p_mras.save()
- mr_mras.set_approvers(approvals_required = 1)
+ mr.approvals.set_approvers(approvals_required=1)
+ # or
+ mr_mras.approvals_required = 1
+ mr_mras.save()
Change project-level MR allowed approvers::