Source

flake8 / flake8 / engine.py

Diff from to

flake8/engine.py

 
 
 def get_parser():
+    """This returns an instance of optparse.OptionParser with all the
+    extensions registered and options set. This wraps ``pep8.get_parser``.
+    """
     (extensions, parser_hooks, options_hooks) = _register_extensions()
     details = ', '.join(['%s: %s' % ext for ext in extensions])
     parser = pep8.get_parser('flake8', '%s (%s)' % (__version__, details))
 
 
 def get_style_guide(**kwargs):
-    """Parse the options and configure the checker."""
+    """Parse the options and configure the checker. This returns a sub-class 
+    of ``pep8.StyleGuide``."""
     kwargs['parser'], options_hooks = get_parser()
     styleguide = StyleGuide(**kwargs)
     options = styleguide.options