From c8f3ba1d241c29ab1afe184024d11eb27dee36b5 Mon Sep 17 00:00:00 2001 From: Abhro R <5664668+abhro@users.noreply.github.com> Date: Thu, 11 Jul 2024 15:11:05 -0400 Subject: [PATCH] Add markdown ref links to types and methods --- src/FileIO.jl | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/src/FileIO.jl b/src/FileIO.jl index 3a19da2..c362f2f 100644 --- a/src/FileIO.jl +++ b/src/FileIO.jl @@ -42,26 +42,26 @@ include("registry.jl") `FileIO` API (brief summary, see individual functions for more detail): - `format"PNG"`: specifies a particular defined format -- `File{fmt}` and `Stream{fmt}`: types of objects that declare that a resource has a particular format `fmt` +- [`File{fmt}`](@ref) and [`Stream{fmt}`](@ref): types of objects that declare that a resource has a particular format `fmt` -- `load([filename|stream])`: read data in formatted file, inferring the format +- [`load([filename|stream])`](@ref): read data in formatted file, inferring the format - `load(File{format"PNG"}(filename))`: specify the format manually -- `loadstreaming([filename|stream])`: similar to `load`, except that it returns an object that can be read from -- `save(filename, data...)` for similar operations involving saving data -- `savestreaming([filename|stream])`: similar to `save`, except that it returns an object that can be written to +- [`loadstreaming([filename|stream])`](@ref): similar to `load`, except that it returns an object that can be read from +- [`save(filename, data...)`](@ref) for similar operations involving saving data +- [`savestreaming([filename|stream])`](@ref): similar to `save`, except that it returns an object that can be written to - `io = open(f::File, args...)` opens a file -- `io = stream(s::Stream)` returns the IOStream from the query object `s` +- [`io = stream(s::Stream)`](@ref stream) returns the IOStream from the query object `s` -- `query([filename|stream])`: attempt to infer the format of `filename` -- `unknown(q)` returns true if a query can't be resolved -- `skipmagic(io, fmt)` sets the position of `io` to just after the magic bytes -- `magic(fmt)` returns the magic bytes for format `fmt` -- `info(fmt)` returns `(magic, extensions)` for format `fmt` +- [`query([filename|stream])`](@ref): attempt to infer the format of `filename` +- [`unknown(q)`](@ref) returns true if a query can't be resolved +- [`skipmagic(io, fmt)`](@ref) sets the position of `io` to just after the magic bytes +- [`magic(fmt)`](@ref) returns the magic bytes for format `fmt` +- [`info(fmt)`](@ref) returns `(magic, extensions)` for format `fmt` -- `add_format(fmt, magic, extension, libraries...)`: register a new format -- `add_loader(fmt, :Package)`: indicate that `Package` supports loading files of type `fmt` -- `add_saver(fmt, :Package)`: indicate that `Package` supports saving files of type `fmt` +- [`add_format(fmt, magic, extension, libraries...)`](@ref): register a new format +- [`add_loader(fmt, :Package)`](@ref): indicate that `Package` supports loading files of type `fmt` +- [`add_saver(fmt, :Package)`](@ref): indicate that `Package` supports saving files of type `fmt` """ FileIO