summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2018-11-08 17:05:42 -0800
committerJoffrey F <joffrey@docker.com>2018-11-08 17:05:42 -0800
commit6bfe4c90906b3ff737b256825b5059c893a6a4d1 (patch)
tree82f6727ae95f29b333055a94b9dc69b8e418d652
parent6064947431dd36b8aa33a5f2eb850b03302de5ee (diff)
downloaddocker-py-6bfe4c90906b3ff737b256825b5059c893a6a4d1.tar.gz
Document attr caching for Container objects
Signed-off-by: Joffrey F <joffrey@docker.com>
-rw-r--r--docker/models/containers.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/docker/models/containers.py b/docker/models/containers.py
index bba0395..a3fd1a8 100644
--- a/docker/models/containers.py
+++ b/docker/models/containers.py
@@ -15,7 +15,12 @@ from .resource import Collection, Model
class Container(Model):
-
+ """ Local representation of a container object. Detailed configuration may
+ be accessed through the :py:attr:`attrs` attribute. Note that local
+ attributes are cached; users may call :py:meth:`reload` to
+ query the Docker daemon for the current properties, causing
+ :py:attr:`attrs` to be refreshed.
+ """
@property
def name(self):
"""