From b9d6d10297096a7acb0e1ed4aa229c1fbc846a5a Mon Sep 17 00:00:00 2001 From: "John L. Villalovos" Date: Fri, 24 Jun 2022 19:50:49 -0700 Subject: [PATCH 1/2] 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. --- docs/gl_objects/merge_request_approvals.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/gl_objects/merge_request_approvals.rst b/docs/gl_objects/merge_request_approvals.rst index 661e0c16e..fcbfbe55d 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:: From 2b5813ae1db2a9c0b736131fc0b2950777926c66 Mon Sep 17 00:00:00 2001 From: Nejc Habjan Date: Sat, 25 Jun 2022 15:18:56 +0200 Subject: [PATCH 2/2] chore(docs): tweak argument formatting --- docs/gl_objects/merge_request_approvals.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/gl_objects/merge_request_approvals.rst b/docs/gl_objects/merge_request_approvals.rst index fcbfbe55d..86659deb0 100644 --- a/docs/gl_objects/merge_request_approvals.rst +++ b/docs/gl_objects/merge_request_approvals.rst @@ -58,7 +58,7 @@ Change project-level or MR-level MR approvals settings:: p_mras.approvals_before_merge = 2 p_mras.save() - mr.approvals.set_approvers(approvals_required = 1) + mr.approvals.set_approvers(approvals_required=1) # or mr_mras.approvals_required = 1 mr_mras.save()