Commits

Anonymous committed cdb39c8

put init params in class docs

Comments (0)

Files changed (3)

docs/build/conf.py

 # is relative to the documentation root, use os.path.abspath to make it
 # absolute, like shown here.
 sys.path.insert(0, os.path.abspath('../../'))
-sys.path.insert(0, os.path.abspath('.'))
 
 import dogpile
 
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'builder']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 
-autodoc_default_flags = 'special-members'
 
 # -- Options for HTML output ---------------------------------------------------
 

dogpile/dogpile.py

     thread/process to be elected as the creator of a new value, 
     while other threads/processes continue to return the previous version 
     of that value.
-    
+
+    :param expiretime: Expiration time in seconds.
+    :param init: if True, set the 'createdtime' to the
+     current time.
+    :param lock: a mutex object that provides
+     ``acquire()`` and ``release()`` methods.
+        
     """
     def __init__(self, expiretime, init=False, lock=None):
         """Construct a new :class:`.Dogpile`.
 
-        :param expiretime: Expiration time in seconds.
-        :param init: if True, set the 'createdtime' to the
-         current time.
-        :param lock: a mutex object that provides
-         ``acquire()`` and ``release()`` methods.
-        
         """
         if lock:
             self.dogpilelock = lock

dogpile/nameregistry.py

     all threads requesting a certain key use the same
     :class:`.Dogpile` object, without the need to maintain
     each :class:`.Dogpile` object persistently in memory.
-    
+
+    :param creator: A function that will create a new
+     value, given the identifier passed to the :meth:`.NameRegistry.get`
+     method.
+
     """
     _locks = weakref.WeakValueDictionary()
     _mutex = threading.RLock()
     def __init__(self, creator):
         """Create a new :class:`.NameRegistry`.
         
-        :param creator: A function that will create a new
-         value, given the identifier passed to the :meth:`.NameRegistry.get`
-         method.
          
         """
         self._values = weakref.WeakValueDictionary()