Skip to content

Commit 2a023f1

Browse files
committed
Fix/add admonition blocks in docstrings
1 parent d12c399 commit 2a023f1

File tree

3 files changed

+14
-11
lines changed

3 files changed

+14
-11
lines changed

src/machines.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1044,9 +1044,10 @@ To serialise using a different format, see [`serializable`](@ref).
10441044
Machines are deserialized using the `machine` constructor as shown in
10451045
the example below.
10461046
1047-
> The implementation of `save` for machines changed in MLJ 0.18
1048-
> (MLJBase 0.20). You can only restore a machine saved using older
1049-
> versions of MLJ using an older version.
1047+
!!! note
1048+
The implementation of `save` for machines changed in MLJ 0.18
1049+
(MLJBase 0.20). You can only restore a machine saved using older
1050+
versions of MLJ using an older version.
10501051
10511052
### Example
10521053

src/resampling.jl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -752,15 +752,15 @@ Base.show(io::IO, e::CompactPerformanceEvaluation) =
752752
## USER CONTROL OF DEFAULT LOGGING
753753

754754
const DOC_DEFAULT_LOGGER =
755-
"""
755+
"""
756756
757-
The default logger is used in calls to [`evaluate!`](@ref) and [`evaluate`](@ref), and
758-
in the constructors `TunedModel` and `IteratedModel`, unless the `logger` keyword is
759-
explicitly specified.
757+
The default logger is used in calls to [`evaluate!`](@ref) and [`evaluate`](@ref), and
758+
in the constructors `TunedModel` and `IteratedModel`, unless the `logger` keyword is
759+
explicitly specified.
760760
761-
!!! note
761+
!!! note
762762
763-
Prior to MLJ v0.20.7 (and MLJBase 1.5) the default logger was always `nothing`.
763+
Prior to MLJ v0.20.7 (and MLJBase 1.5) the default logger was always `nothing`.
764764
765765
"""
766766

src/show.jl

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,10 @@ MLJBase.HANDLE_GIVEN_ID[objectid(value)] = :x
3434
Registered objects get displayed using the variable name to which it
3535
was bound in calls to `show(x)`, etc.
3636
37-
WARNING: As with any `const` declaration, binding `x` to new value of
38-
the same type is not prevented and the registration will not be updated.
37+
!!! warning
38+
39+
As with any `const` declaration, binding `x` to new value of
40+
the same type is not prevented and the registration will not be updated.
3941
4042
"""
4143
macro constant(ex)

0 commit comments

Comments
 (0)