[no ci] Update docstring to specify when the entity can be deleted

PGijsbers · PGijsbers · commit 880a59730f8f · 2023-02-23T15:32:53.000+01:00
diff --git a/openml/datasets/functions.py b/openml/datasets/functions.py
@@ -1274,7 +1274,10 @@ def _get_online_dataset_format(dataset_id):
 
 
 def delete_dataset(dataset_id: int) -> bool:
-    """Deletes a dataset from the OpenML server.
+    """Delete dataset with id `dataset_id` from the OpenML server.
+
+    This can only be done if you are the owner of the dataset and
+    no tasks are attached to the dataset.
 
     Parameters
     ----------
@@ -1284,6 +1287,6 @@ def delete_dataset(dataset_id: int) -> bool:
     Returns
     -------
     bool
-        True if the deletion was successful. False otherwise
+        True if the deletion was successful. False otherwise.
     """
     return openml.utils._delete_entity("dataset", dataset_id)
diff --git a/openml/flows/functions.py b/openml/flows/functions.py
@@ -550,7 +550,10 @@ def _create_flow_from_xml(flow_xml: str) -> OpenMLFlow:
 
 
 def delete_flow(flow_id: int) -> bool:
-    """Deletes a flow from the OpenML server.
+    """Delete flow with id `flow_id` from the OpenML server.
+
+    You can only delete flows which you uploaded and which
+    which are not linked to runs.
 
     Parameters
     ----------
@@ -560,6 +563,6 @@ def delete_flow(flow_id: int) -> bool:
     Returns
     -------
     bool
-        True if the deletion was successful. False otherwise
+        True if the deletion was successful. False otherwise.
     """
     return openml.utils._delete_entity("flow", flow_id)
diff --git a/openml/runs/functions.py b/openml/runs/functions.py
@@ -1208,7 +1208,9 @@ def format_prediction(
 
 
 def delete_run(run_id: int) -> bool:
-    """Deletes a run from the OpenML server.
+    """Delete run with id `run_id` from the OpenML server.
+
+    You can only delete runs which you uploaded.
 
     Parameters
     ----------
@@ -1218,6 +1220,6 @@ def delete_run(run_id: int) -> bool:
     Returns
     -------
     bool
-        True if the deletion was successful. False otherwise
+        True if the deletion was successful. False otherwise.
     """
     return openml.utils._delete_entity("run", run_id)
diff --git a/openml/tasks/functions.py b/openml/tasks/functions.py
@@ -548,7 +548,10 @@ def create_task(
 
 
 def delete_task(task_id: int) -> bool:
-    """Deletes a task from the OpenML server.
+    """Delete task with id `task_id` from the OpenML server.
+
+    You can only delete tasks which you created and have
+    no runs associated with them.
 
     Parameters
     ----------
@@ -558,6 +561,6 @@ def delete_task(task_id: int) -> bool:
     Returns
     -------
     bool
-        True if the deletion was successful. False otherwise
+        True if the deletion was successful. False otherwise.
     """
     return openml.utils._delete_entity("task", task_id)
