Mercurial > repos > public > sbplib_julia
changeset 860:568058183791 operator_storage_array_of_table
Rename argument for `read_stencil_set`: `fn` -> `filename`
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Wed, 19 Jan 2022 07:17:53 +0100 |
| parents | 0ed9ac097200 |
| children | b1f65b98778d |
| files | src/SbpOperators/readoperator.jl |
| diffstat | 1 files changed, 3 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/src/SbpOperators/readoperator.jl Tue Jan 18 22:24:40 2022 +0100 +++ b/src/SbpOperators/readoperator.jl Wed Jan 19 07:17:53 2022 +0100 @@ -10,12 +10,10 @@ export sbp_operators_path -#REVIEW: Reference fn in doc for read_stencil_set. -# Is it the filename of the TOML? """ - read_stencil_set(fn; filters) + read_stencil_set(filename; filters) -Picks out a stencil set from the given TOML file based on some key-value +Picks out a stencil set from a TOML file based on some key-value filters. If more than one set matches the filters an error is raised. The returned stencil set contains parsed TOML intended for functions like `parse_scalar` and `parse_stencil`. @@ -31,7 +29,7 @@ See also [`sbp_operators_path`](@ref), [`get_stencil_set`](@ref), [`parse_stencil`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref),. """ -read_stencil_set(fn; filters...) = get_stencil_set(TOML.parsefile(fn); filters...) +read_stencil_set(filename; filters...) = get_stencil_set(TOML.parsefile(filename); filters...) """ get_stencil_set(parsed_toml; filters...)