Skip to content

Fix docs for replace and replace! #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ph-kev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix docs for replace and replace! #439

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions src/Var.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2814,10 +2814,11 @@ function set_reference_date!(var::OutputVar, reference_date)
end

"""
replace(var::OutputVar, old_new::Pair...)
replace(var::OutputVar, old_new::Pair...; [count::Integer])

Return a `OutputVar` where, for each pair `old => new`, all occurences of `old` are
replaced by `new` in `var.data`
Return an `OutputVar` where, for each pair `old => new`, all occurrences of `old` are
replaced by `new` in `var.data`. If `count` is specified, then replace at most `count`
values in total.

This function is useful if there are `NaN`s or `missing` values in the data. For instance,
you want to use the ocean mask, but there are `NaN`s in the ocean. You can replace all the
Expand All @@ -2835,8 +2836,9 @@ end
"""
replace!(var::OutputVar, old_new::Pair...; [count::Integer])

For each pair `old => new`, all occurences of `old` are replaced by `new` in
`var.data`. See [`replace`](@ref).
For each pair `old => new`, all occurrences of `old` are replaced by `new` in
`var.data`. If `count` is specified, then replace at most `count` values in total. See
[`replace`](@ref).

This function is useful if there are `NaN`s or `missing` values in the data. For instance,
you want to use the ocean mask, but there are `NaN`s in the ocean. You can replace all the
Expand All @@ -2852,10 +2854,10 @@ function Base.replace!(
end

"""
replace!(new::Union{Function, Type}, var::OutputVar; [count::Integer])
replace(new::Union{Function, Type}, var::OutputVar; [count::Integer])

Return a new `OutputVar where each value of `var.data` is replaced by `new(x)`. If `count`
is specified, then replace at most `count` values in total.
Return a new `OutputVar` where each value `x` of `var.data` is replaced by `new(x)`. If
`count` is specified, then replace at most `count` values in total.
"""
function Base.replace(
new::Union{Function, Type},
Expand All @@ -2869,8 +2871,8 @@ end
"""
replace!(new::Union{Function, Type}, var::OutputVar; [count::Integer])

Return each value of `var.data` by `new(x)`. If `count` is specified, then replace at most
`count` values in total.
Replace each value `x` of `var.data` by `new(x)`. If `count` is specified, then replace at
most `count` values in total.
"""
function Base.replace!(
new::Union{Function, Type},
Expand Down
Loading