Skip to content

Commit

Permalink
edits to docstrings. #18
Browse files Browse the repository at this point in the history
  • Loading branch information
davemfish committed Mar 7, 2024
1 parent c066224 commit e21288b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
11 changes: 9 additions & 2 deletions src/geometamaker/geometamaker.py
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,8 @@ def __init__(self, source_dataset_path=None):
Instantiating without a ``source_dataset_path`` creates an MCF template.
Args:
source_dataset_path (string): path to dataset to which the metadata
applies
source_dataset_path (string): path or URL to dataset to which the
metadata applies
"""
self.mcf = None
Expand Down Expand Up @@ -551,6 +551,13 @@ def write(self, workspace=None):
- 'myraster.tif.yml'
- 'myraster.tif.xml'
Args:
workspace (str): if ``None``, files write to the same location
as the source data. If not ``None``, a path to a local directory
to write files. They will still be named to match the source
filename. Use this option if the source data is not on the local
filesystem.
"""
if workspace is None:
target_mcf_path = self.mcf_path
Expand Down
2 changes: 1 addition & 1 deletion tests/test_geometamaker.py
Original file line number Diff line number Diff line change
Expand Up @@ -675,4 +675,4 @@ def test_write_to_local_workspace(self):
temp_dir, f'{os.path.basename(datasource_path)}.yml')))
self.assertTrue(
os.path.exists(os.path.join(
temp_dir, f'{os.path.basename(datasource_path)}.xml')))
temp_dir, f'{os.path.basename(datasource_path)}.xml')))

0 comments on commit e21288b

Please sign in to comment.