Skip to content

Fix syntax in example in documentation #392

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

Merged
merged 2 commits into from
Jul 18, 2024
Merged

Fix syntax in example in documentation #392

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7114f5
Fix syntax in example in documentation
PatrickHaecker Jul 10, 2024
a697088
Merge branch 'master' into patch-1
nhz2 Jul 18, 2024
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
2 changes: 1 addition & 1 deletion docs/src/registering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Before going into detail explaining the arguments of `add_format`,
here is a real example that could be used to register an I/O package for one of the [Netpbm image formats](https://en.wikipedia.org/wiki/Netpbm#File_formats):

```
add_format(format"PPMBinary", "P6", ".ppm", [:Netpbm => UUID("f09324ee-3d7c-5217-9330-fc30815ba969")]
add_format(format"PPMBinary", "P6", ".ppm", [:Netpbm => UUID("f09324ee-3d7c-5217-9330-fc30815ba969")])
```

Briefly, this indicates that files in this format typically have extension `.ppm`, the file contents typically start with "P6" (the byte sequence `[0x50, 0x36]`), and these files can be read and written by the [Netpbm package](https://github.com/JuliaIO/Netpbm.jl). (The `UUID` is Julia's unique identifier for this registered package and can be obtained from the `Project.toml` file.)
Expand Down
Loading