add docstring

Author: isVoid

numba_cuda/numba/cuda/cudadrv/managed_module.py

@@ -5,6 +5,8 @@
 
 
 class _CuFuncProxy:
+    """See `ManagedModule` for more details
+    """
     def __init__(self, module, cufunc):
         self._module = module
         self._cufunc = cufunc
@@ -21,6 +23,14 @@ def __getattr__(self, name):
 
 class ManagedModule:
     def __init__(self, module, setup_callbacks, teardown_callbacks):
+        """ctypes module with setup and teardown callbacks
+        The use of managedmodule is the same as a ctypes module,
+        with the exception of `get_function`, which returns a wrapped
+        cufunc object. The wrapped object provides `init_module`
+        and `lazy_finalize_module` method. Which are used
+        to initialize and finalize the module when stream is available
+        in the later stage of the compilation pipeline.
+        """
         # To be updated to object code
         if not isinstance(module, CtypesModule):
             raise TypeError("module must be a CtypesModule")
@@ -43,11 +53,14 @@ def __init__(self, module, setup_callbacks, teardown_callbacks):
         self._teardown_callbacks = teardown_callbacks
 
     def _init(self, stream):
+        """Eagerly call the setup functions for cumodule on `stream`
+        """
         for setup in self._setup_callbacks:
             setup(self._module, stream)
 
     def _lazy_finalize(self, stream):
-
+        """Set teardown function for cumodule via weakref finalizer.
+        """
         def lazy_callback(callbacks, module, stream):
             for teardown in callbacks:
                 teardown(module, stream)
@@ -69,6 +82,8 @@ def lazy_callback(callbacks, module, stream):
             )
 
     def get_function(self, name):
+        """Returns wrapped CtypesFunc object.
+        """
         ctypesfunc = self._module.get_function(name)
         return _CuFuncProxy(self, ctypesfunc)