Skip to content

Commit d897b70

Browse files
committed
Docstrings update
1 parent dc60e03 commit d897b70

File tree

1 file changed

+21
-42
lines changed

1 file changed

+21
-42
lines changed

bittensor/utils/substrate_utils/storage.py

Lines changed: 21 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -56,18 +56,16 @@ def create_from_data(
5656
"""
5757
Create a StorageKey instance providing raw storage key bytes
5858
59-
Parameters
60-
----------
61-
data: bytes representation of the storage key
62-
runtime_config: RuntimeConfigurationObject
63-
metadata: GenericMetadataVersioned
64-
value_scale_type: type string of to decode result data
65-
pallet: name of pallet
66-
storage_function: name of storage function
67-
68-
Returns
69-
-------
70-
StorageKey
59+
Args:
60+
data: bytes representation of the storage key
61+
runtime_config: RuntimeConfigurationObject
62+
metadata: GenericMetadataVersioned
63+
value_scale_type: type string of to decode result data
64+
pallet: name of pallet
65+
storage_function: name of storage function
66+
67+
Returns:
68+
StorageKey
7169
"""
7270
if not value_scale_type and pallet and storage_function:
7371
metadata_pallet = metadata.get_metadata_pallet(pallet)
@@ -107,17 +105,15 @@ def create_from_storage_function(
107105
"""
108106
Create a StorageKey instance providing storage function details
109107
110-
Parameters
111-
----------
112-
pallet: name of pallet
113-
storage_function: name of storage function
114-
params: Optional list of parameters in case of a Mapped storage function
115-
runtime_config: RuntimeConfigurationObject
116-
metadata: GenericMetadataVersioned
117-
118-
Returns
119-
-------
120-
StorageKey
108+
Args:
109+
pallet: name of pallet
110+
storage_function: name of storage function
111+
params: Optional list of parameters in case of a Mapped storage function
112+
runtime_config: RuntimeConfigurationObject
113+
metadata: GenericMetadataVersioned
114+
115+
Returns:
116+
StorageKey
121117
"""
122118
storage_key_obj = cls(
123119
pallet=pallet,
@@ -149,9 +145,7 @@ def to_hex(self) -> str:
149145
"""
150146
Returns a Hex-string representation of current StorageKey data
151147
152-
Returns
153-
-------
154-
str
148+
Returns:
155149
Hex string
156150
"""
157151
if self.data:
@@ -160,10 +154,6 @@ def to_hex(self) -> str:
160154
def generate(self) -> bytes:
161155
"""
162156
Generate a storage key for current specified pallet/function/params
163-
164-
Returns
165-
-------
166-
bytes
167157
"""
168158

169159
# Search storage call in metadata
@@ -206,7 +196,7 @@ def generate(self) -> bytes:
206196
self.params_encoded.append(param_obj.encode(param))
207197

208198
for idx, param in enumerate(self.params_encoded):
209-
# Get hasher assiociated with param
199+
# Get hasher associated with param
210200
try:
211201
param_hasher = hashers[idx]
212202
except IndexError:
@@ -251,17 +241,6 @@ def generate(self) -> bytes:
251241
return self.data
252242

253243
def decode_scale_value(self, data: Optional[ScaleBytes] = None) -> ScaleType:
254-
"""
255-
256-
Parameters
257-
----------
258-
data
259-
260-
Returns
261-
-------
262-
263-
"""
264-
265244
result_found = False
266245

267246
if data is not None:

0 commit comments

Comments
 (0)