Merge pull request #28 from JuliaAI/dev

For a 3.3 release

Author: ablaom

Project.toml

@@ -1,7 +1,7 @@
 name = "StatisticalTraits"
 uuid = "64bff920-2084-43da-a3e6-9bb72801c0c9"
 authors = ["Anthony D. Blaom <[email protected]>"]
-version = "3.2.0"
+version = "3.3.0"
 
 [deps]
 ScientificTypesBase = "30f210dd-8aff-4c5f-94ba-8e64358c1161"

src/StatisticalTraits.jl

@@ -42,6 +42,7 @@ const TRAITS = [
     :supports_training_losses,
     :deep_properties,
     :reporting_operations,
+    :constructor,
 ]
 
 
@@ -172,6 +173,7 @@ abstract_type(::Type)   = Any
 is_wrapper(::Type)      = false     # or `true`
 supports_online(::Type) = false     # or `true`
 docstring(M::Type)      = string(M) # some `String`
+docstring(Constructor::Function) = Base.Docs.doc(Constructor) |> string
 is_supervised(::Type)   = false     # or `true`
 human_name(M::Type)     = snakecase(name(M), delim=' ') # `name` defined below
 orientation(::Type)     = :loss  # or `:score`, `:other`
@@ -184,6 +186,7 @@ iteration_parameter(::Type)      = nothing
 supports_training_losses(::Type) = false
 deep_properties(::Type) = ()
 reporting_operations(::Type) = ()
+constructor(::Type) = nothing
 
 # Returns a tuple, with one entry per field of `T` (the type of some
 # statistical model, for example). Each entry is `nothing` or defines

test/runtests.jl

@@ -46,6 +46,7 @@ end
 @testset "docstring" begin
     @test docstring(Foo(1,'x')) == "Foo"
     @test docstring(Fruit.RedApple(4)) == "Main.Fruit.RedApple{Int64}"
+    @test docstring(sin) == Base.Docs.doc(sin) |> string
 end
 
 @testset "hyperparameter_ranges" begin