Skip to content

Commit 5583eaa

Browse files
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>
1 parent a825844 commit 5583eaa

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/gl_objects/merge_request_approvals.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,10 @@ Change project-level or MR-level MR approvals settings::
5858
p_mras.approvals_before_merge = 2
5959
p_mras.save()
6060

61-
mr_mras.set_approvers(approvals_required = 1)
61+
mr.approvals.set_approvers(approvals_required=1)
62+
# or
63+
mr_mras.approvals_required = 1
64+
mr_mras.save()
6265

6366
Change project-level MR allowed approvers::
6467

0 commit comments

Comments
 (0)