Document QuoteNode

JuliaLang · Mar 15, 2019 · b21d1e6 · b21d1e6
1 parent 74ff95e
commit b21d1e6
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/base/docs/basedocs.jl b/base/docs/basedocs.jl
@@ -2178,4 +2178,11 @@ The base library of Julia. `Base` is a module that contains basic functionality
 """
 Base.Base
 
+"""
+    QuoteNode
+
+A quoted piece of code, that does not support interpolation. See the [manual section about QuoteNodes](@ref man-quote-node) for details.
+"""
+QuoteNode
+
 end
diff --git a/doc/src/base/base.md b/doc/src/base/base.md
@@ -396,6 +396,7 @@ Meta.@lower
 Meta.parse(::AbstractString, ::Int)
 Meta.parse(::AbstractString)
 Meta.ParseError
+Core.QuoteNode
 Base.macroexpand
 Base.@macroexpand
 Base.@macroexpand1

diff --git a/doc/src/manual/metaprogramming.md b/doc/src/manual/metaprogramming.md
@@ -328,9 +328,15 @@ Expr
 As we have seen, such expressions support interpolation with `$`.
 However, in some situations it is necessary to quote code *without* performing interpolation.
 This kind of quoting does not yet have syntax, but is represented internally
-as an object of type `QuoteNode`.
-The parser yields `QuoteNode`s for simple quoted items like symbols:
+as an object of type `QuoteNode`:
+```jldoctest interp1
+julia> quot(Expr(:$, :(1+2))) |> eval
+3
 
+julia> QuoteNode(Expr(:$, :(1+2))) |> eval
+:($(Expr(:$, :(1 + 2))))
+```
+The parser yields `QuoteNode`s for simple quoted items like symbols:
 ```jldoctest interp1
 julia> dump(Meta.parse(":x"))
 QuoteNode