Skip to content

Commit

Permalink
Merge branch 'master' into doc-patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
nhz2 authored Jul 18, 2024
2 parents 7c4b88a + 9fc2b47 commit 8c46de7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion .github/workflows/Documenter.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
name: Documenter

on:
push:
branches: [master]
Expand All @@ -7,13 +8,17 @@ on:

jobs:
Documenter:
permissions:
contents: write
pull-requests: read
statuses: write
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: nightly # change this to 1.6 once's that's official
version: '1.10'
show-versioninfo: true # this causes versioninfo to be printed to the action log
- uses: julia-actions/julia-buildpkg@latest
- uses: julia-actions/julia-docdeploy@latest
Expand Down
2 changes: 1 addition & 1 deletion docs/src/registering.md
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):

```julia
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

0 comments on commit 8c46de7

Please sign in to comment.