diff options
| author | Joshua Harlow <harlowja@yahoo-inc.com> | 2015-04-08 12:12:58 -0700 |
|---|---|---|
| committer | Joshua Harlow <harlowja@yahoo-inc.com> | 2015-04-08 12:35:07 -0700 |
| commit | 6569329e9b314c55763ee40805b617d5e78c965f (patch) | |
| tree | 78c9204c8c5434023638e0ba72aed4188c4a75ee /tooz/drivers/ipc.py | |
| parent | 9efa54a75b23cb638b88708c262bbbb39e5a0d6d (diff) | |
| download | tooz-6569329e9b314c55763ee40805b617d5e78c965f.tar.gz | |
Beef up the docstrings on the various drivers
Change-Id: I1ca05629cc5f28c1248767bb18384a29801bece2
Diffstat (limited to 'tooz/drivers/ipc.py')
| -rw-r--r-- | tooz/drivers/ipc.py | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/tooz/drivers/ipc.py b/tooz/drivers/ipc.py index f00c575..03664cc 100644 --- a/tooz/drivers/ipc.py +++ b/tooz/drivers/ipc.py @@ -122,7 +122,14 @@ class IPCLock(locking.Lock): class IPCDriver(coordination.CoordinationDriver): - """A IPC based driver.""" + """A `IPC`_ based driver. + + This driver uses `IPC`_ concepts to provide the coordination driver + semantics and required API(s). It **is** missing some functionality but + in the future these not implemented API(s) will be filled in. + + .. _IPC: http://en.wikipedia.org/wiki/Inter-process_communication + """ _SEGMENT_SIZE = 1024 _GROUP_LIST_KEY = "GROUP_LIST" |