Update doc-strings for snapshot methods in Share Driver

Update doc-strings for methods create_snapshot() and
delete_snapshot() in Share Driver

Change-Id: I05e7d9c6b508863b12560f57138a648adace5e41
Partial-Bug: #1444914
This commit is contained in:
Igor Malinovskiy 2015-04-17 11:30:20 +03:00
parent 7cc4fc08f7
commit 6076717efd
1 changed files with 14 additions and 2 deletions

View File

@ -237,7 +237,13 @@ class ShareDriver(object):
raise NotImplementedError()
def create_snapshot(self, context, snapshot, share_server=None):
"""Is called to create snapshot."""
"""Is called to create snapshot.
:param context: Current context
:param snapshot: Snapshot model. Share model could be
retrieved through snapshot['share'].
:param share_server: Share server model or None.
"""
raise NotImplementedError()
def delete_share(self, context, share, share_server=None):
@ -245,7 +251,13 @@ class ShareDriver(object):
raise NotImplementedError()
def delete_snapshot(self, context, snapshot, share_server=None):
"""Is called to remove snapshot."""
"""Is called to remove snapshot.
:param context: Current context
:param snapshot: Snapshot model. Share model could be
retrieved through snapshot['share'].
:param share_server: Share server model or None.
"""
raise NotImplementedError()
def get_pool(self, share):