Merge pull request #12593 from JuliaLang/yyc/doc-str

Accept string interpolation as doc string
JuliaLang · Aug 13, 2015 · f40da0f · f40da0f
2 parents d7193a3 + dcc4661
commit f40da0f
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/src/julia-parser.scm b/src/julia-parser.scm
@@ -2071,12 +2071,13 @@
 
 (define (doc-string-literal? e)
   (or (simple-string-literal? e)
+      (and (pair? e) (eq? 'string (car e))) ; string interpolation
       (and (length= e 3) (eq? (car e) 'macrocall)
            (simple-string-literal? (caddr e))
            (eq? (cadr e) '@doc_str))))
 
 (define (parse-docstring s production)
-  (let* ((ex    (production s)))
+  (let* ((ex (production s)))
     (if (and (doc-string-literal? ex)
              (let loop ((t (peek-token s)))
                (cond

diff --git a/test/docs.jl b/test/docs.jl
@@ -196,3 +196,15 @@ end
 let fd = meta(I12515)[Base.collect]
     @test fd.order[1].sig == Tuple{Type{I12515.EmptyType{TypeVar(:T, Any, true)}}}
 end
+
+
+# PR #12593
+
+"$(1 + 1)"
+f12593_1() = 1
+
+"$(1 + 1) 2"
+f12593_2() = 1
+
+@test (@doc f12593_1) !== nothing
+@test (@doc f12593_2) !== nothing