summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2015-09-16 12:25:34 -0700
committerJoffrey F <joffrey@docker.com>2015-09-16 12:55:49 -0700
commitea9e13ff2b08212e3a7e7ab501698d0f2789fe74 (patch)
treeed5d43a63b71efeef4cf92ffb28f261f5fc5ba8f /docs
parentacd5e634ffa62428562c945878dcb67edd6ecf61 (diff)
downloaddocker-py-ea9e13ff2b08212e3a7e7ab501698d0f2789fe74.tar.gz
Detail which exception is thrown by remove_volume
Signed-off-by: Joffrey F <joffrey@docker.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/api.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/api.md b/docs/api.md
index 4add429..4e5d54c 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -741,7 +741,8 @@ Remove a volume. Similar to the `docker volume rm` command.
* name (str): The volume's name
-**Returns** (bool): True on successful removal. Failure will raise an exception.
+**Returns** (bool): True on successful removal. Failure will raise a
+`docker.errors.APIError` exception.
## rename