attribute documentation now overrides non attribute documentation.

This makes it possible to document aliased methods and other things::

    def foo(self):
        pass

    #: an alias for foo()
    foo_alias = foo

Also attribute documentation can contain paragraphs now.

1 files changed, 6 insertions, 2 deletions

diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py
index 1b0a599a..ea03340a 100644
--- a/sphinx/util/docstrings.py
+++ b/sphinx/util/docstrings.py
@@ -49,8 +49,12 @@ def prepare_commentdoc(s):
     result = []
     lines = [line.strip() for line in s.expandtabs().splitlines()]
     for line in lines:
-        if line.startswith('#: '):
-            result.append(line[3:])
+        if line.startswith('#:'):
+            line = line[2:]
+            # the first space after the comment is ignored
+            if line and line[0] == ' ':
+                line = line[1:]
+            result.append(line)
     if result and result[-1]:
         result.append('')
     return result