Skip to content

Commit

Permalink
Update docs for delete_package (#1290)
Browse files Browse the repository at this point in the history
  • Loading branch information
dimaryaz authored Oct 17, 2019
1 parent fb16bb2 commit 8c956af
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 2 deletions.
1 change: 1 addition & 0 deletions api/python/quilt3/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ def delete_package(name, registry=None, top_hash=None):
Parameters:
name (str): Name of the package
registry (str): The registry the package will be removed from
top_hash (str): Optional. A package hash to delete, instead of the whole package.
"""
validate_package_name(name)
usr, pkg = name.split('/')
Expand Down
3 changes: 2 additions & 1 deletion docs/API Reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,15 @@ __Returns__
`QuiltConfig`: (an ordered Mapping)


## delete\_package(name, registry=None) {#delete\_package}
## delete\_package(name, registry=None, top\_hash=None) {#delete\_package}

Delete a package. Deletes only the manifest entries and not the underlying files.

__Arguments__

* __name (str)__: Name of the package
* __registry (str)__: The registry the package will be removed from
* __top_hash (str)__: Optional. A package hash to delete, instead of the whole package.


## list\_package\_versions(name, registry=None) {#list\_package\_versions}
Expand Down
2 changes: 1 addition & 1 deletion gendocs/build.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#! python3
#!/usr/bin/env python3

import sys
import subprocess
Expand Down

0 comments on commit 8c956af

Please sign in to comment.