8000 Drop invalid doc about raised exceptions · matusf/python-gitlab@197ffd7 · GitHub
[go: up one dir, main page]

Skip to content

Commit 197ffd7

Browse files
author
Gauvain Pocentek
committed
Drop invalid doc about raised exceptions
1 parent a0f215c commit 197ffd7

File tree

1 file changed

+2
-59
lines changed

1 file changed

+2
-59
lines changed

gitlab/v4/objects.py

Lines changed: 2 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -395,10 +395,6 @@ def content(self, streamed=False, action=None, chunk_size=1024, **kwargs):
395395
396396
Returns:
397397
str: The snippet content.
398-
399-
Raises:
400-
GitlabConnectionError: If the server cannot be reached.
401-
GitlabGetError: If the server fails to perform the request.
402398
"""
403399
path = '/snippets/%s/raw' % self.get_id()
404400
result = self.manager.gitlab.http_get(path, streamed=streamed,
@@ -522,10 +518,6 @@ def erase(self, **kwargs):
522518

523519
def keep_artifacts(self, **kwargs):
524520
"""Prevent artifacts from being delete when expiration is set.
525-
526-
Raises:
527-
GitlabConnectionError: If the server cannot be reached.
528-
GitlabCreateError: If the request failed.
529521
"""
530522
path = '%s/%s/artifacts/keep' % (self.manager.path, self.get_id())
531523
self.manager.gitlab.http_post(path)
@@ -544,10 +536,6 @@ def artifacts(self, streamed=False, action=None, chunk_size=1024,
544536
545537
Returns:
546538
str: The artifacts if `streamed` is False, None otherwise.
547-
548-
Raises:
549-
GitlabConnectionError: If the server cannot be reached.
550-
GitlabGetError: If the artifacts are not available.
551539
"""
552540
path = '%s/%s/artifacts' % (self.manager.path, self.get_id())
553541
result = self.manager.gitlab.get_http(path, streamed=streamed,
@@ -567,10 +555,6 @@ def trace(self, streamed=False, action=None, chunk_size=1024, **kwargs):
567555
568556
Returns:
569557
str: The trace.
570-
571-
Raises:
572-
GitlabConnectionError: If the server cannot be reached.
573-
GitlabGetError: If the trace is not available.
574558
"""
575559
path = '%s/%s/trace' % (self.manager.path, self.get_id())
576560
result = self.manager.gitlab.get_http(path, streamed=streamed,
@@ -643,9 +627,6 @@ def cherry_pick(self, branch, **kwargs):
643627
644628
Args:
645629
branch (str): Name of target branch.
646-
647-
Raises:
648-
GitlabCherryPickError: If the cherry pick could not be applied.
649630
"""
650631
path = '%s/%s/cherry_pick' % (self.manager.path, self.get_id())
651632
post_data = {'branch': branch}
@@ -764,11 +745,7 @@ class ProjectIssue(SubscribableMixin, TodoMixin, TimeTrackingMixin, SaveMixin,
764745
_managers = (('notes', 'ProjectIssueNoteManager'), )
765746

766747
def move(self, to_project_id, **kwargs):
767-
"""Move the issue to another project.
768-
769-
Raises:
770-
GitlabConnectionError: If the server cannot be reached.
771-
"""
748+
"""Move the issue to another project."""
772749
path = '%s/%s/move' % (self.manager.path, self.get_id())
773750
data = {'to_project_id': to_project_id}
774751
server_data = self.manager.gitlab.http_post(path, post_data=data,
@@ -840,11 +817,6 @@ def set_release_description(self, description, **kwargs):
840817
841818
Args:
842819
description (str): Description of the release.
843-
844-
Raises:
845-
GitlabConnectionError: If the server cannot be reached.
846-
GitlabCreateError: If the server fails to create the release.
847-
GitlabUpdateError: If the server fails to update the release.
848820
"""
849821
path = '%s/%s/release' % (self.manager.path, self.get_id())
850822
data = {'description': description}
@@ -1099,9 +1071,6 @@ def get(self, file_path, **kwargs):
10991071
11001072
Returns:
11011073
object: The generated RESTObject.
1102-
1103-
Raises:
1104-
GitlabGetError: If the server cannot perform the request.
11051074
"""
11061075
file_path = file_path.replace('/', '%2F')
11071076
return GetMixin.get(self, file_path, **kwargs)
@@ -1122,10 +1091,6 @@ def raw(self, file_path, ref, streamed=False, action=None, chunk_size=1024,
11221091
11231092
Returns:
11241093
str: The file content
1125-
1126-
Raises:
1127-
GitlabConnectionError: If the server cannot be reached.
1128-
GitlabGetError: If the server fails to perform the request.
11291094
"""
11301095
file_path = file_path.replace('/', '%2F')
11311096
path = '%s/%s/raw' % (self.path, file_path)
@@ -1200,10 +1165,6 @@ def content(self, streamed=False, action=None, chunk_size=1024, **kwargs):
12001165
12011166
Returns:
12021167
str: The snippet content
1203-
1204-
Raises:
1205-
GitlabConnectionError: If the server cannot be reached.
1206-
GitlabGetError: If the server fails to perform the request.
12071168
"""
12081169
path = "%s/%s/raw" % (self.manager.path, self.get_id())
12091170
result = self.manager.gitlab.http_get(path, streamed=streamed,
@@ -1222,12 +1183,7 @@ class ProjectSnippetManager(CRUDMixin, RESTManager):
12221183

12231184
class ProjectTrigger(SaveMixin, RESTObject):
12241185
def take_ownership(self, **kwargs):
1225-
"""Update the owner of a trigger.
1226-
1227-
Raises:
1228-
GitlabConnectionError: If the server cannot be reached.
1229-
GitlabGetError: If the server fails to perform the request.
1230-
"""
1186+
"""Update the owner of a trigger."""
12311187
path = '%s/%s/take_ownership' % (self.manager.path, self.get_id())
12321188
server_data = self.manager.gitlab.http_post(path, **kwargs)
12331189
self._update_attrs(server_data)
@@ -1611,10 +1567,6 @@ def all(self, scope=None, **kwargs):
16111567
16121568
Returns:
16131569
list(Runner): a list of runners matching the scope.
1614-
1615-
Raises:
1616-
GitlabConnectionError: If the server cannot be reached.
1617-
GitlabListError: If the resource cannot be found
16181570
"""
16191571
path = '/runners/all'
16201572
query_data = {}
@@ -1645,10 +1597,6 @@ def mark_all_as_done(self, **kwargs):
16451597
16461598
Returns:
16471599
The number of todos maked done.
1648-
1649-
Raises:
1650-
GitlabConnectionError: If the server cannot be reached.
1651-
GitlabDeleteError: If the resource cannot be found
16521600
"""
16531601
self.gitlab.http_post('/todos/mark_as_done', **kwargs)
16541602

@@ -1708,11 +1656,6 @@ def transfer_project(self, id, **kwargs):
17081656
17091657
Attrs:
17101658
id (int): ID of the project to transfer.
1711-
1712-
Raises:
1713-
GitlabConnectionError: If the server cannot be reached.
1714-
GitlabTransferProjectError: If the server fails to perform the
1715-
request.
17161659
"""
17171660
path = '/groups/%d/projects/%d' % (self.id, id)
17181661
self.manager.gitlab.http_post(path, **kwargs)

0 commit comments

Comments
 (0)
0