Add info on minor release

gdcc · Nov 10, 2021 · 9339137 · 9339137
1 parent 555a727
commit 9339137
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/pyDataverse/docs/source/user/basic-usage.rst b/src/pyDataverse/docs/source/user/basic-usage.rst
@@ -297,6 +297,8 @@ always leads to a major version change:
     >>> resp = api.publish_dataset(ds_pid, release_type="major")
     Dataset doi:10.5072/FK2/EO7BNB published
 
+Note that the version release needs to be ``major`` if any files were added or modified. 
+A ``minor`` release will work for metadata changes, but it will return an error if there are changes in the dataset content. 
 
 .. _user_basic-usage_download-data: