diff options
author | John L. Villalovos <john@sodarock.com> | 2022-11-08 08:20:56 -0800 |
---|---|---|
committer | Nejc Habjan <hab.nejc@gmail.com> | 2022-11-08 17:34:49 +0100 |
commit | c3600b49e4d41b1c4f2748dd6f2a331c331d8706 (patch) | |
tree | 0a32bafc1320c5d76c5d3ea3ab84adc7d06294fb | |
parent | e6f1bd6333a884433f808b2a84670079f9a70f0a (diff) | |
download | gitlab-c3600b49e4d41b1c4f2748dd6f2a331c331d8706.tar.gz |
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
-rw-r--r-- | docs/gl_objects/groups.rst | 2 | ||||
-rw-r--r-- | 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 71e955f..b467836 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 7d4885a..7fc0ab9 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() |