Skip to content

Commit 0c0518e

Browse files
authored
docs: fix python references (#281)
1 parent 52313c1 commit 0c0518e

6 files changed

Lines changed: 10 additions & 11 deletions

File tree

hcloud/certificates/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def update(
8181
New name to set
8282
:param labels: Dict[str, str] (optional)
8383
User-defined labels (key-value pairs)
84-
:return: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>
84+
:return: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>`
8585
"""
8686
return self._client.update(self, name, labels)
8787

hcloud/floating_ips/client.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ def get_actions_list(
4646
4747
:param status: List[str] (optional)
4848
Response will have only actions with specified statuses. Choices: `running` `success` `error`
49-
:param sort: List[str] (optional)
49+
:param sort: List[str] (optional)
5050
Specify how the results are sorted. Choices: `id` `id:asc` `id:desc` `command` `command:asc` `command:desc` `status` `status:asc` `status:desc` `progress` `progress:asc` `progress:desc` `started` `started:asc` `started:desc` `finished` `finished:asc` `finished:desc`
51-
:param page: int (optional)
51+
:param page: int (optional)
5252
Specifies the page to fetch
53-
:param per_page: int (optional)
53+
:param per_page: int (optional)
5454
Specifies how many results are returned by page
55-
:return: (List[:class:`BoundAction <hcloud.actions.client.BoundAction>`], :class:`Meta <hcloud.core.domain.Meta>`)
55+
:return: (List[:class:`BoundAction <hcloud.actions.client.BoundAction>`], :class:`Meta <hcloud.core.domain.Meta>`)
5656
"""
5757
return self._client.get_actions_list(self, status, sort, page, per_page)
5858

@@ -67,7 +67,6 @@ def get_actions(
6767
Response will have only actions with specified statuses. Choices: `running` `success` `error`
6868
:param sort: List[str] (optional)
6969
Specify how the results are sorted. Choices: `id` `id:asc` `id:desc` `command` `command:asc` `command:desc` `status` `status:asc` `status:desc` `progress` `progress:asc` `progress:desc` `started` `started:asc` `started:desc` `finished` `finished:asc` `finished:desc`
70-
7170
:return: List[:class:`BoundAction <hcloud.actions.client.BoundAction>`]
7271
"""
7372
return self._client.get_actions(self, status, sort)

hcloud/images/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ def get_by_id(self, id: int) -> BoundImage:
180180
"""Get a specific Image
181181
182182
:param id: int
183-
:return: :class:`BoundImage <hcloud.images.client.BoundImage
183+
:return: :class:`BoundImage <hcloud.images.client.BoundImage`
184184
"""
185185
response = self._client.request(url=f"/images/{id}", method="GET")
186186
return BoundImage(self, response["image"])

hcloud/networks/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ def get_by_id(self, id: int) -> BoundNetwork:
172172
"""Get a specific network
173173
174174
:param id: int
175-
:return: :class:`BoundNetwork <hcloud.networks.client.BoundNetwork>
175+
:return: :class:`BoundNetwork <hcloud.networks.client.BoundNetwork>`
176176
"""
177177
response = self._client.request(url=f"/networks/{id}", method="GET")
178178
return BoundNetwork(self, response["network"])

hcloud/ssh_keys/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def update(
2525
New Description to set
2626
:param labels: Dict[str, str] (optional)
2727
User-defined labels (key-value pairs)
28-
:return: :class:`BoundSSHKey <hcloud.ssh_keys.client.BoundSSHKey>
28+
:return: :class:`BoundSSHKey <hcloud.ssh_keys.client.BoundSSHKey>`
2929
"""
3030
return self._client.update(self, name, labels)
3131

hcloud/volumes/client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def get_actions(
6262
6363
:param status: List[str] (optional)
6464
Response will have only actions with specified statuses. Choices: `running` `success` `error`
65-
:param sort:List[str] (optional)
65+
:param sort: List[str] (optional)
6666
Specify how the results are sorted. Choices: `id` `id:asc` `id:desc` `command` `command:asc` `command:desc` `status` `status:asc` `status:desc` `progress` `progress:asc` `progress:desc` `started` `started:asc` `started:desc` `finished` `finished:asc` `finished:desc`
6767
:return: List[:class:`BoundAction <hcloud.actions.client.BoundAction>`]
6868
"""
@@ -325,7 +325,7 @@ def get_actions(
325325
:param volume: :class:`BoundVolume <hcloud.volumes.client.BoundVolume>` or :class:`Volume <hcloud.volumes.domain.Volume>`
326326
:param status: List[str] (optional)
327327
Response will have only actions with specified statuses. Choices: `running` `success` `error`
328-
:param sort:List[str] (optional)
328+
:param sort: List[str] (optional)
329329
Specify how the results are sorted. Choices: `id` `id:asc` `id:desc` `command` `command:asc` `command:desc` `status` `status:asc` `status:desc` `progress` `progress:asc` `progress:desc` `started` `started:asc` `started:desc` `finished` `finished:asc` `finished:desc`
330330
:return: List[:class:`BoundAction <hcloud.actions.client.BoundAction>`]
331331
"""

0 commit comments

Comments
 (0)