Skip to content

Commit 4277133

Browse files
committed
Add docstrings for replacable IO methods.
1 parent dbac6b7 commit 4277133

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

pystac/io.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,20 @@ def default_stac_object_from_dict_method(d):
2222
else:
2323
return Catalog.from_dict(d)
2424

25+
"""Users of PySTAC can replace the read_text_method in order
26+
to expand the ability of PySTAC to read different file systems.
27+
For example, a client of the library might replace this class
28+
member in it's own __init__.py with a method that can read from
29+
cloud storage.
30+
"""
2531
read_text_method = default_read_text_method
32+
33+
"""Users of PySTAC can replace the writte_text_method in order
34+
to expand the ability of PySTAC to write to different file systems.
35+
For example, a client of the library might replace this class
36+
member in it's own __init__.py with a method that can read from
37+
cloud storage.
38+
"""
2639
write_text_method = default_write_text_method
2740

2841
# Replaced in __init__ to account for extension objects.

0 commit comments

Comments
 (0)