Mercurial > repos > public > sbplib_julia
diff src/SbpOperators/readoperator.jl @ 855:439a5e6c7175 operator_storage_array_of_table
Align docs
author | Vidar Stiernström <vidar.stiernstrom@it.uu.se> |
---|---|
date | Tue, 18 Jan 2022 22:22:18 +0100 |
parents | fe8fe3f01162 |
children | 0ed9ac097200 |
line wrap: on
line diff
--- a/src/SbpOperators/readoperator.jl Tue Jan 18 22:09:55 2022 +0100 +++ b/src/SbpOperators/readoperator.jl Tue Jan 18 22:22:18 2022 +0100 @@ -13,12 +13,12 @@ """ read_stencil_set(fn; filters) -Picks out a stencil set from the given toml file based on some key-value +Picks out a stencil set from the given 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 +returned stencil set contains parsed TOML intended for functions like `parse_scalar` and `parse_stencil`. -The stencil set is not parsed beyond the inital toml parse. To get usable +The stencil set is not parsed beyond the inital TOML parse. To get usable stencils use the `parse_stencil` functions on the fields of the stencil set. The reason for this is that since stencil sets are intended to be very @@ -34,7 +34,8 @@ """ get_stencil_set(parsed_toml; filters...) -Same as `read_stencil_set` but works on already parsed TOML. +Picks out a stencil set from an already parsed TOML based on some key-value +filters. See also [`read_stencil_set`](@ref). """ @@ -60,7 +61,7 @@ """ parse_stencil(parsed_toml) -Accepts parsed toml and reads it as a stencil. +Accepts parsed TOML and reads it as a stencil. See also [`read_stencil_set`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref). """