docs(api): fix incorrect docs for merge_request_approvals (#2094) · python-gitlab/python-gitlab@5583eaa · GitHub

1. python-gitlab
2. python-gitlab

Repository navigation

• Code
• Issues16 (16)
• Pull requests15 (15)
• Discussions
• Actions
• Projects
• Security and quality
• Insights

Commit 5583eaa

Browse filesBrowse the repository at this point in the historyBrowse files

JohnVillalovos

and

nejch

authored

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
Copy full SHA for 5583eaa

1 file changed

+4-1Lines changed: 4 additions & 1 deletion

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• docs/gl_objects
  • merge_request_approvals.rst

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎docs/gl_objects/merge_request_approvals.rst‎

Copy file name to clipboardExpand all lines: docs/gl_objects/merge_request_approvals.rst

+4-1Lines changed: 4 additions & 1 deletion

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -58,7 +58,10 @@ Change project-level or MR-level MR approvals settings::
58	58	p_mras.approvals_before_merge = 2
59	59	p_mras.save()
60	60
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()
62	65
63	66	Change project-level MR allowed approvers::
64	67

0 commit comments

Comments

0 (0)