Skip to content

Commit 19af491

Browse files
committed
improve a docstring
1 parent 9672fa5 commit 19af491

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/MLJModelRegistryTools.jl

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,12 @@ Module providing tools for managing the MLJ Model Registry. To modify the regist
1616
1717
- Point the `MLJModelRegistryTools` module to the location of the registry itself within
1818
your MLJModels.jl clone, using `setpath(path_to_registry)`, as in
19-
`setpath("MyPkgs/MLJModels.jl/src/registry")`.
19+
`setpath("MyPkgs/MLJModels.jl/src/registry")`. To check this worked, try
20+
`MLJRegistryTools.get("MLJBase")`, to see the MLJBase.jl models.
2021
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`.
22+
- To add or update the metadata associated with a package, run [`update(pkg)`](@ref), as
23+
in `update("MLJTransforms"). Ensure that every model provided by the packge appears as a
24+
key in the returned value. Omissions may indicate a bad `load_path`.
2425
2526
- Assuming this is successful, update the metadata for *all* packages in the registry
2627
by running [`update()`](@ref).

0 commit comments

Comments
 (0)