Merge pull request #64 from ziadsawalha/remove-D209

Update D209 to reflect change to PEP-257

Author: Vladimir Keleshev

README.rst

@@ -100,7 +100,7 @@ are grouped as follows:
 +--------------+--------------------------------------------------------------+
 | D20{7,8}     | Docstring {under,over}-indented.                             |
 +--------------+--------------------------------------------------------------+
-| D209         | Multi-line docstring should end with 1 blank line.           |
+| D209         | Put multi-line docstring closing quotes on separate line.    |
 +--------------+--------------------------------------------------------------+
 | **Quotes issues**                                                           |
 +--------------+--------------------------------------------------------------+

pep257.py

@@ -599,22 +599,21 @@ def check_indent(self, definition, docstring):
                     return Error('D207: Docstring is under-indented')
 
     @check_for(Definition)
-    def check_blank_after_last_paragraph(self, definition, docstring):
-        """D209: Multi-line docstring should end with 1 blank line.
+    def check_newline_after_last_paragraph(self, definition, docstring):
+        """D209: Put multi-line docstring closing quotes on separate line.
 
-        The BDFL recommends inserting a blank line between the last
-        paragraph in a multi-line docstring and its closing quotes,
-        placing the closing quotes on a line by themselves.
+        Unless the entire docstring fits on a line, place the closing
+        quotes on a line by themselves.
 
         """
         if docstring:
             lines = [l for l in eval(docstring).split('\n') if not is_blank(l)]
             if len(lines) > 1:
                 lines = eval(docstring).split('\n')
                 blanks = len(list(takewhile(is_blank, reversed(lines))))
-                if blanks != 2:
-                    return Error('D209: Multi-line docstring should end with '
-                                 '1 blank line, found %s' % max(0, blanks - 1))
+                if blanks < 2:
+                    return Error('D209: Put multi-line docstring closing '
+                                 'quotes on separate line')
 
     @check_for(Definition)
     def check_triple_double_quotes(self, definition, docstring):

test.py

@@ -158,31 +158,13 @@ def asdfsdfsdsdsdfsdf24():
     """
 
 
-@expect('D209: Multi-line docstring should end with 1 blank line, found 0')
+@expect('D209: Put multi-line docstring closing quotes on separate line')
 def asdfljdf24():
     """Summary.
 
     Description."""
 
 
-@expect('D209: Multi-line docstring should end with 1 blank line, found 0')
-def asdljlfljdf24():
-    """Summary.
-
-    Description.
-    """
-
-
-@expect('D209: Multi-line docstring should end with 1 blank line, found 2')
-def lklkjllkjl():
-    """Summary.
-
-    Description.
-
-
-    """
-
-
 @expect('D300: Expected """-quotes, got \'\'\'-quotes')
 def lsfklkjllkjl():
     r'''Summary.'''

test_pep257.py

@@ -222,18 +222,3 @@ def test_check_indent():
     """
     pass'''
     assert check('"""%s"""' % context.split('"""')[1], context, None)
-
-
-def test_check_blank_after_last_paragraph():
-    check = pep257.check_blank_after_last_paragraph
-    s1 = '''"""Multiline docstring should end with 1 blank line.
-
-    Blank here:
-
-    """'''
-    s2 = '''"""Multiline docstring should end with 1 blank line.
-
-    No blank here.
-    """'''
-    assert not check(s1, None, None)
-    assert check(s2, None, None)