Skip to content

Commit

Permalink
docs: fix python references (#281)
Browse files Browse the repository at this point in the history
  • Loading branch information
jooola authored Aug 9, 2023
1 parent 52313c1 commit 0c0518e
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 11 deletions.
2 changes: 1 addition & 1 deletion hcloud/certificates/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ def update(
New name to set
:param labels: Dict[str, str] (optional)
User-defined labels (key-value pairs)
:return: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>
:return: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>`
"""
return self._client.update(self, name, labels)

Expand Down
9 changes: 4 additions & 5 deletions hcloud/floating_ips/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ def get_actions_list(
:param status: List[str] (optional)
Response will have only actions with specified statuses. Choices: `running` `success` `error`
:param sort: List[str] (optional)
:param sort: List[str] (optional)
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`
:param page: int (optional)
:param page: int (optional)
Specifies the page to fetch
:param per_page: int (optional)
:param per_page: int (optional)
Specifies how many results are returned by page
:return: (List[:class:`BoundAction <hcloud.actions.client.BoundAction>`], :class:`Meta <hcloud.core.domain.Meta>`)
:return: (List[:class:`BoundAction <hcloud.actions.client.BoundAction>`], :class:`Meta <hcloud.core.domain.Meta>`)
"""
return self._client.get_actions_list(self, status, sort, page, per_page)

Expand All @@ -67,7 +67,6 @@ def get_actions(
Response will have only actions with specified statuses. Choices: `running` `success` `error`
:param sort: List[str] (optional)
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`
:return: List[:class:`BoundAction <hcloud.actions.client.BoundAction>`]
"""
return self._client.get_actions(self, status, sort)
Expand Down
2 changes: 1 addition & 1 deletion hcloud/images/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ def get_by_id(self, id: int) -> BoundImage:
"""Get a specific Image
:param id: int
:return: :class:`BoundImage <hcloud.images.client.BoundImage
:return: :class:`BoundImage <hcloud.images.client.BoundImage`
"""
response = self._client.request(url=f"/images/{id}", method="GET")
return BoundImage(self, response["image"])
Expand Down
2 changes: 1 addition & 1 deletion hcloud/networks/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ def get_by_id(self, id: int) -> BoundNetwork:
"""Get a specific network
:param id: int
:return: :class:`BoundNetwork <hcloud.networks.client.BoundNetwork>
:return: :class:`BoundNetwork <hcloud.networks.client.BoundNetwork>`
"""
response = self._client.request(url=f"/networks/{id}", method="GET")
return BoundNetwork(self, response["network"])
Expand Down
2 changes: 1 addition & 1 deletion hcloud/ssh_keys/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def update(
New Description to set
:param labels: Dict[str, str] (optional)
User-defined labels (key-value pairs)
:return: :class:`BoundSSHKey <hcloud.ssh_keys.client.BoundSSHKey>
:return: :class:`BoundSSHKey <hcloud.ssh_keys.client.BoundSSHKey>`
"""
return self._client.update(self, name, labels)

Expand Down
4 changes: 2 additions & 2 deletions hcloud/volumes/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def get_actions(
:param status: List[str] (optional)
Response will have only actions with specified statuses. Choices: `running` `success` `error`
:param sort:List[str] (optional)
:param sort: List[str] (optional)
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`
:return: List[:class:`BoundAction <hcloud.actions.client.BoundAction>`]
"""
Expand Down Expand Up @@ -325,7 +325,7 @@ def get_actions(
:param volume: :class:`BoundVolume <hcloud.volumes.client.BoundVolume>` or :class:`Volume <hcloud.volumes.domain.Volume>`
:param status: List[str] (optional)
Response will have only actions with specified statuses. Choices: `running` `success` `error`
:param sort:List[str] (optional)
:param sort: List[str] (optional)
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`
:return: List[:class:`BoundAction <hcloud.actions.client.BoundAction>`]
"""
Expand Down

0 comments on commit 0c0518e

Please sign in to comment.