Document the Composer __init__ method.

handroll · Sep 11, 2015 · bd4d2e7 · bd4d2e7
1 parent 8807fb8
commit bd4d2e7
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/composers.rst b/docs/composers.rst
@@ -12,6 +12,8 @@ constructs a ``Composer`` instance by invoking a no parameter constructor.
 .. autoclass:: handroll.composers.Composer
    :members:
 
+   .. automethod:: handroll.composers.Composer.__init__
+
 A plugin should be added to the ``handroll.composers`` entry point group. For
 example, the ``MarkdownComposer`` plugin included by default defines its entry
 point in ``setup.py`` as:

diff --git a/handroll/composers/__init__.py b/handroll/composers/__init__.py
@@ -15,7 +15,7 @@ class Composer(object):
     """Interface for all composers"""
 
     def __init__(self, config):
-        """Each composer is given access to the configuration."""
+        """Each composer is given the configuration when instantiated."""
         self._config = config
 
     def compose(self, catalog, source_file, out_dir):