Skip to content

Commit c3e794b

Browse files
committed
Improve doc-string
1 parent a6bddef commit c3e794b

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/MLJModelRegistryTools.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ Module providing tools for managing the MLJ Model Registry. To modify the regist
1818
your MLJModels.jl clone, using `setpath(path_to_registry)`, as in
1919
`setpath("MyPkgs/MLJModels.jl/src/registry")`.
2020
21-
- To add or update the metadata associated with a package, run [`update(pkg)`](@ref).
21+
- To add or update the metadata associated with a package, run
22+
[`update(pkg)`](@ref). Ensure that every model provided by the packge appears as a key
23+
in the returned value. Omissions may indicate a bad `load_path`.
2224
2325
- Assuming this is successful, update the metadata for *all* packages in the registry
2426
by running [`update()`](@ref).

0 commit comments

Comments
 (0)