diff options
author | Oz <nahumoz@gmail.com> | 2012-12-16 23:27:09 +0100 |
---|---|---|
committer | Lucas De Marchi <lucas.demarchi@intel.com> | 2014-03-20 07:22:53 -0300 |
commit | 344d0e501831ef72acb69ec94b520ac1f5341c77 (patch) | |
tree | 8ba0b4992222023eb5b52572400f5e618f4f58ae | |
parent | 969e77939ae2f9d4df9bfa5a60d6498090b8e8c4 (diff) | |
download | kmod-344d0e501831ef72acb69ec94b520ac1f5341c77.tar.gz |
python: add docstring to insert and remove methods
-rw-r--r-- | libkmod/python/kmod/module.pyx | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/libkmod/python/kmod/module.pyx b/libkmod/python/kmod/module.pyx index eadfbbf..42aa92e 100644 --- a/libkmod/python/kmod/module.pyx +++ b/libkmod/python/kmod/module.pyx @@ -117,6 +117,13 @@ cdef class Module (object): def insert(self, flags=0, extra_options=None, install_callback=None, data=None, print_action_callback=None): + """ + insert module to current tree. + e.g. + km = kmod.Kmod() + tp = km.module_from_name("thinkpad_acpi") + tp.insert(extra_options='fan_control=1') + """ cdef char *opt = NULL #cdef _libkmod_h.install_callback_t install = NULL cdef int (*install)( @@ -139,6 +146,13 @@ cdef class Module (object): raise _KmodError('Could not load module') def remove(self, flags=0): + """ + remove module from current tree + e.g. + km = kmod.Kmod() + tp = km.module_from_name("thinkpad_acpi") + tp.remove() + """ err = _libkmod_h.kmod_module_remove_module(self.module, flags) if err < 0: raise _KmodError('Could not remove module') |