From 8c956afa46db380bc8c4dc240b5fb40cd094c6f0 Mon Sep 17 00:00:00 2001 From: Dima Ryazanov Date: Thu, 17 Oct 2019 14:50:36 -0700 Subject: [PATCH] Update docs for delete_package (#1290) --- api/python/quilt3/api.py | 1 + docs/API Reference/api.md | 3 ++- gendocs/build.py | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/api/python/quilt3/api.py b/api/python/quilt3/api.py index 7ed74086ebe..b68ccda7c56 100644 --- a/api/python/quilt3/api.py +++ b/api/python/quilt3/api.py @@ -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('/') diff --git a/docs/API Reference/api.md b/docs/API Reference/api.md index b19a4a1cc7c..44d20119719 100644 --- a/docs/API Reference/api.md +++ b/docs/API Reference/api.md @@ -37,7 +37,7 @@ __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. @@ -45,6 +45,7 @@ __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} diff --git a/gendocs/build.py b/gendocs/build.py index 02a2f74ecf6..002bd4ccf79 100755 --- a/gendocs/build.py +++ b/gendocs/build.py @@ -1,4 +1,4 @@ -#! python3 +#!/usr/bin/env python3 import sys import subprocess