Merge pull request #202 from mih/doc

doc(`replace_datafile`): clarify and correct parameter description
gdcc · Aug 22, 2024 · 9bd067e · 9bd067e
2 parents 8445a09 + 984af0c
commit 9bd067e
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/pyDataverse/api.py b/pyDataverse/api.py
@@ -1894,14 +1894,14 @@ def replace_datafile(self, identifier, filename, json_str, is_filepid=True):
         Parameters
         ----------
         identifier : str
-            Identifier of the dataset.
+            Identifier of the file to be replaced.
         filename : str
             Full filename with path.
         json_str : str
             Metadata as JSON string.
         is_filepid : bool
-            ``True`` to use persistent identifier for datafile. ``False``, if
-            not.
+            ``True`` if ``identifier`` is a persistent identifier for the datafile.
+            ``False``, if not.
 
         Returns
         -------