docs(api): pushrules remove saying `None` is returned when not found · python-gitlab/python-gitlab@c3600b4 · GitHub

1. python-gitlab
2. python-gitlab

Repository navigation

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

Commit c3600b4

Browse filesBrowse the repository at this point in the historyBrowse files

JohnVillalovos

authored and

nejch

committed

docs(api): pushrules remove saying None is returned when not found

In `groups.pushrules.get()`, GitLab does not return `None` when no rules are found. GitLab returns a 404. Update docs to not say it will return `None` Also update docs in `project.pushrules.get()` to be consistent. Not 100% sure if it returns `None` or returns a 404, but we don't need to document that. Closes: #2368

1 parent e6f1bd6 commit c3600b4
Copy full SHA for c3600b4

2 files changed

+2-2Lines changed: 2 additions & 2 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• docs/gl_objects
  • groups.rst
  • projects.rst

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎docs/gl_objects/groups.rst‎

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

+1-1Lines changed: 1 addition & 1 deletion

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -402,7 +402,7 @@ Create group push rules (at least one rule is necessary)::
402	402
403	403	group.pushrules.create({'deny_delete_tag': True})
404	404
405		- Get group push rules (returns ``None`` if there are no push rules)::
	405	+ Get group push rules::
406	406
407	407	pr = group.pushrules.get()
408	408

Collapse file

‎docs/gl_objects/projects.rst‎

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

+1-1Lines changed: 1 addition & 1 deletion

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -804,7 +804,7 @@ Create project push rules (at least one rule is necessary)::
804	804
805	805	project.pushrules.create({'deny_delete_tag': True})
806	806
807		- Get project push rules (returns ``None`` if there are no push rules)::
	807	+ Get project push rules::
808	808
809	809	pr = project.pushrules.get()
810	810

0 commit comments

Comments

0 (0)