From 765037dfc028b06b6e49f3547a514af8d27214c8 Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Fri, 20 Mar 2015 08:58:20 -0700 Subject: [PATCH] Ensure docstring on storage properties To ensure that sphinx generates docs for these methods and shows them (without docstrings they do not show up) add some basic docstrings on the exposed storage classes properties. Change-Id: Iab2d2432403c7065fe8cb679e8e64a24ec17b53f --- taskflow/storage.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/taskflow/storage.py b/taskflow/storage.py index bb9f0a21..5386907e 100644 --- a/taskflow/storage.py +++ b/taskflow/storage.py @@ -263,16 +263,19 @@ class Storage(object): @property def flow_name(self): + """The flow detail name this storage unit is associated with.""" # This never changes (so no read locking needed). return self._flowdetail.name @property def flow_uuid(self): + """The flow detail uuid this storage unit is associated with.""" # This never changes (so no read locking needed). return self._flowdetail.uuid @property def backend(self): + """The backend this storage unit is associated with.""" # This never changes (so no read locking needed). return self._backend