[lxc-devel] [pylxd/master] Update documentation for Container.execute

[ppkt on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 378 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20180417/cd4d8906/attachment.bin>
-------------- next part --------------
From 18c80e9c30fc0e5ce479cb3642d09b4714cea34e Mon Sep 17 00:00:00 2001
From: Karol Werner <karol at ppkt.eu>
Date: Tue, 17 Apr 2018 14:30:20 +0200
Subject: [PATCH] Update documentation for Container.execute

Signed-off-by: Karol Werner <karol at ppkt.eu>
---
 doc/source/containers.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/source/containers.rst b/doc/source/containers.rst
index 133d78b..dc4f287 100644
--- a/doc/source/containers.rst
+++ b/doc/source/containers.rst
@@ -62,8 +62,8 @@ Container methods
   - `unfreeze` - Resume the container
   - `execute` - Execute a command on the container. The first argument is
     a list, in the form of `subprocess.Popen` with each item of the command
-    as a separate item in the list. Returns a two part tuple of
-    `(stdout, stderr)`. This method will block while the command is executed.
+    as a separate item in the list. Returns a tuple of `(exit_code, stdout, stderr)`.
+    This method will block while the command is executed.
   - `migrate` - Migrate the container. The first argument is a client
     connection to the destination server. This call is asynchronous, so
     `wait=True` is optional. The container on the new client is returned.