Strip newlines in summary to fix formatting issues

Fixes #686
lsegal · Jul 26, 2013 · 45808e9 · 45808e9
1 parent fa272a6
commit 45808e9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/lib/yard/docstring.rb b/lib/yard/docstring.rb
@@ -171,7 +171,7 @@ def line
     def summary
       resolve_reference
       return @summary if @summary
-      stripped = self.gsub(/<.+?>/m, '').strip
+      stripped = self.gsub(/<.+?>/m, '').gsub(/[\r\n](?![\r\n])/, ' ').strip
       open_parens = ['{', '(', '[']
       close_parens = ['}', ')', ']']
       num_parens = 0

diff --git a/spec/docstring_spec.rb b/spec/docstring_spec.rb
@@ -57,6 +57,11 @@
       doc.summary.should == 'Hello world.'
     end
 
+    it "should strip newlines in first paragraph before summarizing" do
+      doc = Docstring.new("Foo\n<code>==</code> bar.")
+      doc.summary.should == 'Foo == bar.'
+    end
+
     it "should return the first sentence" do
       o = Docstring.new("DOCSTRING. Another sentence")
       o.summary.should == "DOCSTRING."