Merge pull request #3 from Chilipp/sig-fix

Fixed escape of * in summary table

Author: Chilipp

autodocsumm/__init__.py

@@ -611,7 +611,7 @@ def get_items_from_documenters(self, documenters):
             else:
                 max_chars = max(10, max_item_chars - len(display_name))
                 sig = mangle_signature(sig, max_chars=max_chars)
-                sig = sig.replace('*', r'\*')
+#                sig = sig.replace('*', r'\*')
 
             # -- Grab the documentation
 

tests/sphinx_supp/dummy.py

@@ -46,6 +46,9 @@ def test_method(self):
         """Test if the method is included"""
         pass
 
+    def test_method_args_kwargs(self, *args, **kwargs):
+        """The stars at args and kwargs should not be escaped"""
+
     #: to test if the class attribute is included
     test_attr = None
 

tests/test_autodocsumm.py

@@ -82,6 +82,12 @@ def test_class(self, app, status, warning):
         self.assertIn('<span class="pre">test_method</span>', html)
         self.assertIn('<span class="pre">test_attr</span>', html)
 
+        # test escaping of *
+        self.assertNotIn(r'\*args', html)
+        self.assertNotIn(r', \*\*kwargs', html)
+        self.assertIn('*args', html)
+        self.assertIn('**kwargs', html)
+
         # test whether the right objects are included
         self.assertIn('<span class="pre">class_caller</span>', html)
         self.assertIn('Caller docstring for class attribute', html)