tweak

Author: ablaom

src/metadata_utils.jl

@@ -214,7 +214,9 @@ function doc_header(SomeModelType)
         $name
         ```
 
-        Model type for $human_name, based on [$(package_name).jl]($package_url).
+        Model type for $human_name, based on
+        [$(package_name).jl]($package_url), and implementing the MLJ
+        model interface.
 
         From MLJ, the type can be imported using
 
@@ -260,7 +262,7 @@ function synthesize_docstring(M)
     text_for_params = ""
     if !is_wrapper(M)
         model = M()
-        isempty(hyperparameters) || (text_for_params *= "### Hyper-parameters")
+        isempty(hyperparameters) || (text_for_params *= "# Hyper-parameters")
         for p in hyperparameters
             value = getproperty(model, p)
             text_for_params *= "\n\n- `$p = $value`"

test/model_traits.jl

@@ -69,7 +69,9 @@ M.human_name(::Type{<:U1}) = "my model"
         U1
         ```
 
-        Model type for my model, based on [Bach.jl](www.did_he_write_565.com).
+        Model type for my model, based on
+        [Bach.jl](www.did_he_write_565.com), and implementing the MLJ
+        model interface.
 
         From MLJ, the type can be imported using
 
@@ -81,7 +83,7 @@ M.human_name(::Type{<:U1}) = "my model"
         Provide keyword arguments to override hyper-parameter defaults, as in
         `U1(a=...)`.
 
-        ### Hyper-parameters
+        # Hyper-parameters
 
         - `a = 0`