Skip to content

Commit 61cf5dd

Browse files
committed
add correct function docstring
1 parent 9bf31bd commit 61cf5dd

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

activestorage/active.py

+9-3
Original file line numberDiff line numberDiff line change
@@ -173,10 +173,16 @@ def __init__(
173173
self.data_read = 0
174174

175175
def __load_nc_file(self):
176-
""" Get the netcdf file and its b-tree"""
176+
"""
177+
Get the netcdf file and its b-tree.
178+
179+
This private method is used only if the input to Active
180+
is not a pyfive.high_level.Dataset object. In that case,
181+
any file opening is skipped, and ncvar is not used. The
182+
Dataset object will have already contained the b-tree,
183+
and `_filename` attribute.
184+
"""
177185
ncvar = self.ncvar
178-
# in all cases we need an open netcdf file to get at attributes
179-
# we keep it open because we need it's b-tree
180186
if self.storage_type is None:
181187
nc = pyfive.File(self.uri)
182188
elif self.storage_type == "s3":

0 commit comments

Comments
 (0)