Skip to content

Commit 09c090e

Browse files
authored
fix some doc errors (#136)
1 parent 6085070 commit 09c090e

File tree

4 files changed

+4
-10
lines changed

4 files changed

+4
-10
lines changed

.github/workflows/CI.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ jobs:
4747
- uses: codecov/codecov-action@v4
4848
with:
4949
file: lcov.info
50+
token: ${{ secrets.CODECOV_TOKEN }}
5051
- uses: coverallsapp/github-action@master
5152
with:
5253
github-token: ${{ secrets.GITHUB_TOKEN }}

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ makedocs(
66
format = Documenter.HTML(),
77
sitename = "Zarr.jl",
88
authors = "Fabian Gans, Martijn Visser",
9+
warnonly=[:missing_docs,],
910
pages = [
1011
"Home" => "index.md",
1112
"Tutorial" => "tutorial.md",

docs/src/missings.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,7 @@ julia> readdir(p)
2929
and only after writing some non-fillvalue data there will be chunks on disk:
3030

3131
````jldoctest fillval
32-
julia> z[1:20,1:10] .= 5
33-
Disk Array with size 20 x 10
34-
32+
julia> z[1:20,1:10] .= 5;
3533
3634
julia> readdir(p)
3735
4-element Vector{String}:
@@ -44,9 +42,7 @@ julia> readdir(p)
4442
Also be aware that during `setindex!`, when chunks only contain FillValues, the chunk will not be written to disk or deleted if it existed before. So if we write `-1`s again into our array, the corresponding chunks will be deleted.
4543

4644
````jldoctest fillval
47-
julia> z[1:10,1:10] .= -1
48-
Disk Array with size 10 x 10
49-
45+
julia> z[1:10,1:10] .= -1;
5046
5147
julia> readdir(p)
5248
3-element Vector{String}:

docs/src/storage.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,9 @@ CurrentModule = Zarr
88

99
```@docs
1010
storagesize
11-
zname
1211
Base.getindex(d::AbstractStore,i::String)
1312
Base.setindex!(d::AbstractStore,v,i::String)
1413
subdirs
15-
Base.keys(d::AbstractStore)
16-
newsub
17-
getsub
1814
```
1915

2016
You can get some inspiration on how to implement this by looking at the source code of existing storage backends.

0 commit comments

Comments
 (0)