Added doccomment.

Signed-off-by: Ewan Mellor <ewan@xensource.com>
This commit is contained in:
emellor@leeni.uk.xensource.com committed 2005-10-30 17:19:35 +01:00
1 parent 0ac3c6cbd5
commit 6bcc179281
1 file changed
+9 -3
@@ -69,9 +69,15 @@ class DevController:
def destroyDevice(self, devid):
"""Destroy the specified device.
The implementation here simply deletes the appropriate paths from
the store. This may be overridden by subclasses who need to perform
other tasks on destruction.
@param devid The device ID, or something device-specific from which
the device ID can be determined (such as a guest-side device name).
The implementation here simply deletes the appropriate paths from the
store. This may be overridden by subclasses who need to perform other
tasks on destruction. Further, the implementation here can only
accept integer device IDs, or values that can be converted to
integers. Subclasses may accept other values and convert them to
integers before passing them here.
"""
devid = int(devid)
Reference in new issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.