Skip to content

Commit 4f3a93f

Browse files
committed
Added docs.
1 parent a955c75 commit 4f3a93f

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

src/pygobbler/remove_asset.py

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
def remove_asset(project: str, asset: str, staging: str, url: str, force: bool = False):
55
"""
66
Remove an asset of a project from the registry.
7+
This should only be performed by Gobbler instance administrators.
8+
Consider running :py:func:`~pygobbler.reroute_links.reroute_links` beforehand to avoid dangling references to files in this asset.
79
810
Args:
911
project:

src/pygobbler/remove_project.py

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
def remove_project(project: str, staging: str, url: str):
55
"""
66
Remove a project from the registry.
7+
This should only be performed by Gobbler instance administrators.
8+
Consider running :py:func:`~pygobbler.reroute_links.reroute_links` beforehand to avoid dangling references to files in this project.
79
810
Args:
911
project:

src/pygobbler/remove_version.py

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
def remove_version(project: str, asset: str, version: str, staging: str, url: str, force: bool = False):
55
"""
66
Remove a version of a project asset from the registry.
7+
This should only be performed by Gobbler instance administrators.
8+
Consider running :py:func:`~pygobbler.reroute_links.reroute_links` beforehand to avoid dangling references to files in this version.
79
810
Args:
911
project:

0 commit comments

Comments
 (0)