Skip to content
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

Jump to bottom

Document pipe style save #376

Merged
merged 2 commits into from
May 2, 2023
Merged

Document pipe style save #376

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4b8eca
Fix small typo
davidanthoff May 1, 2023
4fcaaa6
Add piping style save to docs
davidanthoff May 1, 2023
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
8 changes: 7 additions & 1 deletion docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Install FileIO within Julia via
```julia
julia> using Pkg

julia> Pkg.add("FileIO")`
julia> Pkg.add("FileIO")
```

## Usage
Expand Down Expand Up @@ -48,6 +48,12 @@ Likewise, saving might be as simple as
save(filename, obj)
```

You can also utilize a piping style to save values to files like this

```julia
obj |> save(filename)
```

If you just want to inspect a file to determine its format, then

```julia
Expand Down