Skip to content

Commit d12c399

Browse files
committed
Fix/add headers in method docstrings
1 parent 5c41370 commit d12c399

File tree

4 files changed

+20
-6
lines changed

4 files changed

+20
-6
lines changed

src/composition/learning_networks/signatures.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,8 @@ See also [`MLJBase.Signature`](@ref).
307307
"""
308308
fitted_params_supplement(signature::Signature) = call_and_copy(fitted_params_nodes(signature))
309309

310-
""" report(signature; supplement=true)
310+
"""
311+
report(signature; supplement=true)
311312
312313
**Private method.**
313314

src/data/datasets_synthetic.jl

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,12 @@ Make portion `s` of vector `θ` exactly 0.
318318
"""
319319
sparsify!(rng, θ, s) =.*= (rand(rng, length(θ)) .< s))
320320

321-
"""Add outliers to portion s of vector."""
321+
"""
322+
outlify!(rng, y, s)
323+
324+
Add outliers to portion `s` of vector.
325+
326+
"""
322327
outlify!(rng, y, s) =
323328
(n = length(y); y .+= 20 * randn(rng, n) .* (rand(rng, n) .< s))
324329

src/machines.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,7 @@ err_missing_model(model) = ErrorException(
529529
)
530530

531531
"""
532-
last_model(mach::Machine)
532+
last_model(mach::Machine)
533533
534534
Return the last model used to train the machine `mach`. This is a bona fide model, even if
535535
`mach.model` is a symbol.

src/show.jl

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,22 @@ macro constant(ex)
5050
end
5151
end
5252

53-
"""to display abbreviated versions of integers"""
53+
"""
54+
abbreviated(n)
55+
56+
Display abbreviated versions of integers.
57+
"""
5458
function abbreviated(n)
5559
as_string = string(n)
5660
return "@"*as_string[end-2:end]
5761
end
5862

59-
"""return abbreviated object id (as string) or it's registered handle
60-
(as string) if this exists"""
63+
"""
64+
handle(X)
65+
66+
return abbreviated object id (as string) or it's registered handle
67+
(as string) if this exists
68+
"""
6169
function handle(X)
6270
id = objectid(X)
6371
if id in keys(HANDLE_GIVEN_ID)

0 commit comments

Comments
 (0)