Skip to content

Commit

Permalink
add correct function docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
valeriupredoi committed Feb 28, 2025
1 parent 9bf31bd commit 61cf5dd
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions activestorage/active.py
Original file line number Diff line number Diff line change
Expand Up @@ -173,10 +173,16 @@ def __init__(
self.data_read = 0

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

0 comments on commit 61cf5dd

Please sign in to comment.