Mercurial > repos > public > sbplib_julia
diff src/SbpOperators/readoperator.jl @ 852:510f744d0876 operator_storage_array_of_table
Add some documentation for the file format
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Fri, 14 Jan 2022 15:39:56 +0100 |
| parents | 91a63b04b1c9 |
| children | fe8fe3f01162 |
line wrap: on
line diff
--- a/src/SbpOperators/readoperator.jl Fri Jan 14 13:42:47 2022 +0100 +++ b/src/SbpOperators/readoperator.jl Fri Jan 14 15:39:56 2022 +0100 @@ -10,10 +10,6 @@ export sbp_operators_path -# TODO: Docs for readoperator.jl - # Parsing as rationals is intentional, allows preserving exactness, which can be lowered using converts or promotions later. - # Documetning the format: Allows representing rationals as strings - """ read_stencil_set(fn; filters) @@ -29,6 +25,8 @@ general, and currently do not include any way to specify how to parse a given section, the exact parsing is left to the user. +For more information see [Operator file format](@ref) in the documentation. + 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...) @@ -62,7 +60,7 @@ """ parse_stencil(parsed_toml) -Accepts parsed parsed_toml and reads it as a stencil +Accepts parsed parsed_toml and reads it as a stencil. See also [`read_stencil_set`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref). """