Skip to content

Commit

Permalink
Update docs, version, changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
stuartmcalpine committed Nov 29, 2024
1 parent e8cdf28 commit 673bc1a
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
## Version 1.0.5

Update delete functionality

- The `delete()` function now takes `name`, `version_string`, `owner` and
`owner_type` as arguments, rather than simply the `dataset_id`.
- One can still delete by the `dataset_id` using the CLI, which now includes a
confirmation step.

## Version 1.0.4

Make more options for querying
Expand Down
6 changes: 3 additions & 3 deletions docs/source/tutorial_notebooks/register_datasets.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@
"source": [
"## 6) Deleting a dataset in the dataregistry\n",
"\n",
"To delete a dataset entry from the dataregistry we call the .delete() function which accepts one argument, the `dataset_id` of the entry you wish to delete, e.g.,"
"To delete a dataset entry from the dataregistry we call the `.delete()` function which accepts four arguments, the `name`, `version_string`, `owner` and `owner_type` of the entry you wish to delete, e.g.,"
]
},
{
Expand All @@ -450,8 +450,8 @@
},
"outputs": [],
"source": [
"# Delete dataset with entry ID == dataset_id\n",
"datareg.Registrar.dataset.delete(dataset_id)"
"# Delete a dataset\n",
"datareg.Registrar.dataset.delete(\"nersc_tutorial:my_first_desc_dataset\", \"1.0.0\", OWNER, \"group\")"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion src/dataregistry/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "1.0.4"
__version__ = "1.0.5"

0 comments on commit 673bc1a

Please sign in to comment.