From 8c33c5bfae9bc9fc23912b3f416158f836bee2ea Mon Sep 17 00:00:00 2001 From: "John L. Villalovos" Date: Tue, 8 Nov 2022 08:20:56 -0800 Subject: [PATCH] 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 --- docs/gl_objects/groups.rst | 2 +- docs/gl_objects/projects.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst index 71e955ff5..b46783631 100644 --- a/docs/gl_objects/groups.rst +++ b/docs/gl_objects/groups.rst @@ -402,7 +402,7 @@ Create group push rules (at least one rule is necessary):: group.pushrules.create({'deny_delete_tag': True}) -Get group push rules (returns ``None`` if there are no push rules):: +Get group push rules:: pr = group.pushrules.get() diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst index 7d4885a22..7fc0ab9c2 100644 --- a/docs/gl_objects/projects.rst +++ b/docs/gl_objects/projects.rst @@ -804,7 +804,7 @@ Create project push rules (at least one rule is necessary):: project.pushrules.create({'deny_delete_tag': True}) -Get project push rules (returns ``None`` if there are no push rules):: +Get project push rules:: pr = project.pushrules.get()