Skip to content

Commit 0837480

Browse files
committed
Add some missing docstrings
1 parent b657da5 commit 0837480

File tree

4 files changed

+15
-0
lines changed

4 files changed

+15
-0
lines changed

upcloud_api/cloud_manager/base.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ class BaseAPI:
1414
api_v = '1.3'
1515

1616
def __init__(self, token, timeout=None):
17+
"""
18+
Initialize the API with a given Authorization token and default timeout.
19+
"""
1720
self.token = token
1821
self.timeout = timeout
1922

upcloud_api/errors.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ class UpCloudAPIError(UpCloudClientError):
1717
"""
1818

1919
def __init__(self, error_code, error_message):
20+
"""
21+
Initialize API error with an error code and message.
22+
"""
2023
self.error_code = error_code
2124
self.error_message = error_message
2225

upcloud_api/server.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,9 @@ def save(self):
141141
self._reset(kwargs)
142142

143143
def destroy(self):
144+
"""
145+
Destroy the server.
146+
"""
144147
self.cloud_manager.delete_server(self.uuid)
145148

146149
def shutdown(self, hard=False, timeout=30):
@@ -258,6 +261,9 @@ def add_firewall_rule(self, FirewallRule):
258261
return self.cloud_manager.create_firewall_rule(self, FirewallRule.to_dict())
259262

260263
def remove_firewall_rule(self, FirewallRule):
264+
"""
265+
Remove a firewall rule.
266+
"""
261267
return FirewallRule.destroy()
262268

263269
def get_firewall_rules(self):

upcloud_api/tag.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ def server_uuids(self):
4747
return [server.uuid for server in self.servers]
4848

4949
def save(self):
50+
"""
51+
Save any changes made to the tag.
52+
"""
5053
tag_dict = self.cloud_manager._modify_tag(
5154
self._api_name, self.description, self.server_uuids, self.name
5255
)

0 commit comments

Comments
 (0)