Merge pull request #21443 from JuliaLang/cv/show_supertypes

Create show_supertypes function
JuliaLang · May 17, 2017 · c2992ac · c2992ac
2 parents cff2d75 + 2478f29
commit c2992ac
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 0 deletions.
diff --git a/base/docs/Docs.jl b/base/docs/Docs.jl
@@ -404,6 +404,13 @@ function summarize(io::IO, T::DataType, binding)
         end
         println(io, "```")
     end
+    if supertype(T) != Any
+        println(io, "**Supertype Hierarchy:**")
+        println(io, "```")
+        Base.show_supertypes(io, T)
+        println(io)
+        println(io, "```")
+    end
 end
 
 function summarize(io::IO, m::Module, binding)

diff --git a/base/show.jl b/base/show.jl
@@ -236,6 +236,16 @@ function show_datatype(io::IO, x::DataType)
     end
 end
 
+function show_supertypes(io::IO, typ::DataType)
+    print(io, typ)
+    while typ != Any
+        typ = supertype(typ)
+        print(io, " <: ", typ)
+    end
+end
+
+show_supertypes(typ::DataType) = show_supertypes(STDOUT, typ)
+
 macro show(exs...)
     blk = Expr(:block)
     for ex in exs

diff --git a/test/docs.jl b/test/docs.jl
@@ -749,6 +749,11 @@ abstract type $(curmod_prefix)Undocumented.B <: $(curmod_prefix)Undocumented.A
 ```
 $(curmod_prefix)Undocumented.D
 ```
+
+**Supertype Hierarchy:**
+```
+$(curmod_prefix)Undocumented.B <: $(curmod_prefix)Undocumented.A <: Any
+```
 """)
 @test docstrings_equal(@doc(Undocumented.B), doc"$doc_str")
 
@@ -759,6 +764,11 @@ No documentation found.
 ```
 mutable struct $(curmod_prefix)Undocumented.C <: $(curmod_prefix)Undocumented.A
 ```
+
+**Supertype Hierarchy:**
+```
+$(curmod_prefix)Undocumented.C <: $(curmod_prefix)Undocumented.A <: Any
+```
 """)
 @test docstrings_equal(@doc(Undocumented.C), doc"$doc_str")
 
@@ -776,6 +786,11 @@ one   :: Any
 two   :: String
 three :: Float64
 ```
+
+**Supertype Hierarchy:**
+```
+$(curmod_prefix)Undocumented.D <: $(curmod_prefix)Undocumented.B <: $(curmod_prefix)Undocumented.A <: Any
+```
 """)
 @test docstrings_equal(@doc(Undocumented.D), doc"$doc_str")
 

diff --git a/test/show.jl b/test/show.jl
@@ -669,3 +669,6 @@ let m = which(T20332{Int}(), (Int,)),
 end
 
 @test sprint(show, Main) == "Main"
+
+@test sprint(Base.show_supertypes, Int64) == "Int64 <: Signed <: Integer <: Real <: Number <: Any"
+@test sprint(Base.show_supertypes, Vector{String}) == "Array{String,1} <: DenseArray{String,1} <: AbstractArray{String,1} <: Any"