fix typejoin docstring (JuliaLang#46018)

Co-authored-by: Shuhei Kadowaki <40514306+aviatesk@users.noreply.github.com>
ffucci · Aug 11, 2022 · 31eb567 · 31eb567
1 parent 9c61dfe
commit 31eb567
Showing 1 changed file with 12 additions and 3 deletions.
diff --git a/base/promotion.jl b/base/promotion.jl
@@ -3,10 +3,19 @@
 ## type join (closest common ancestor, or least upper bound) ##
 
 """
-    typejoin(T, S)
+    typejoin(T, S, ...)
 
-Return the closest common ancestor of `T` and `S`, i.e. the narrowest type from which
-they both inherit.
+Return the closest common ancestor of types `T` and `S`, i.e. the narrowest type from which
+they both inherit. Recurses on additional varargs.
+
+# Examples
+```jldoctest
+julia> typejoin(Int, Float64)
+Real
+
+julia> typejoin(Int, Float64, ComplexF32)
+Number
+```
 """
 typejoin() = Bottom
 typejoin(@nospecialize(t)) = t