Document all the arguments and return values of bdev.Create() and bdev.BlockDev.Create().
Signed-off-by: Bernardo Dal Seno <[email protected]> --- lib/storage/base.py | 13 +++++++++++++ lib/storage/bdev.py | 2 ++ 2 files changed, 15 insertions(+) diff --git a/lib/storage/base.py b/lib/storage/base.py index d07705d..385a78a 100644 --- a/lib/storage/base.py +++ b/lib/storage/base.py @@ -119,6 +119,19 @@ class BlockDev(object): the children. The idea is that these two, taken together, are enough for both creation and assembly (later). + @type unique_id: 2-element tuple or list + @param unique_id: unique identifier; the details depend on the actual device type + @type children: list of L{BlockDev} + @param children: for hierarchical devices, the child devices + @type size: float + @param size: size in MiB + @type params: dict + @param params: device-specific options/parameters + @type excl_stor: bool + @param excl_stor: whether exclusive_storage is active + @rtype: L{BlockDev} + @return: the created device, or C{None} in case of an error + """ raise NotImplementedError diff --git a/lib/storage/bdev.py b/lib/storage/bdev.py index 289df93..404ec9c 100644 --- a/lib/storage/bdev.py +++ b/lib/storage/bdev.py @@ -1796,6 +1796,8 @@ def Create(disk, children, excl_stor): represented by the disk parameter @type excl_stor: boolean @param excl_stor: Whether exclusive_storage is active + @rtype: L{bdev.BlockDev} + @return: the created device, or C{None} in case of an error """ _VerifyDiskType(disk.dev_type) -- 1.8.2.1
