Skip to content

slim down readme and improve docs page #116

slim down readme and improve docs page

slim down readme and improve docs page #116

Triggered via pull request November 23, 2024 14:29
Status Failure
Total duration 3m 45s
Artifacts

Docs.yml

on: pull_request
Fit to window
Zoom out
Zoom in

Annotations

7 errors and 3 warnings
Documentation: ../../../.julia/packages/Documenter/Bs999/src/utilities/utilities.jl#L44
failed to run `@example` block in src/basic_usage.md:74-85 ```@example jldopen("example.jld2", "w") do f write(f, "variant1", 1.0) f["variant2"] = (rand(5), rand(Bool, 3)) end f = jldopen("example.jld2") v1 = read(f, "variant1") v2 = f["variant2"] close(f) v1, v2 ``` exception = UndefVarError: `jldopen` not defined in `Main.__atexample__235` Suggestion: check for spelling errors or missing imports. Hint: a global variable of this name also exists in JLD2. Stacktrace: [1] top-level scope @ basic_usage.md:75 [2] eval @ ./boot.jl:430 [inlined] [3] #60 @ ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:803 [inlined] [4] cd(f::Documenter.var"#60#62"{Module, Expr}, dir::String) @ Base.Filesystem ./file.jl:112 [5] (::Documenter.var"#59#61"{Documenter.Page, Module, Expr})() @ Documenter ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:802 [6] (::IOCapture.var"#5#9"{DataType, Documenter.var"#59#61"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}})() @ IOCapture ~/.julia/packages/IOCapture/Y5rEA/src/IOCapture.jl:170 [7] with_logstate(f::IOCapture.var"#5#9"{DataType, Documenter.var"#59#61"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}}, logstate::Base.CoreLogging.LogState) @ Base.CoreLogging ./logging/logging.jl:522 [8] with_logger(f::Function, logger::Base.CoreLogging.ConsoleLogger) @ Base.CoreLogging ./logging/logging.jl:632 [9] capture(f::Documenter.var"#59#61"{Documenter.Page, Module, Expr}; rethrow::Type, color::Bool, passthrough::Bool, capture_buffer::IOBuffer, io_context::Vector{Any}) @ IOCapture ~/.julia/packages/IOCapture/Y5rEA/src/IOCapture.jl:167 [10] runner(::Type{Documenter.Expanders.ExampleBlocks}, node::MarkdownAST.Node{Nothing}, page::Documenter.Page, doc::Documenter.Document) @ Documenter ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:801
Documentation: ../../../.julia/packages/Documenter/Bs999/src/utilities/utilities.jl#L44
failed to run `@example` block in src/basic_usage.md:90-96 ```@example jldopen("example.jld2", "w") do file mygroup = JLD2.Group(file, "mygroup") mygroup["mystuff"] = 42 display(file) end ``` exception = UndefVarError: `jldopen` not defined in `Main.__atexample__236` Suggestion: check for spelling errors or missing imports. Hint: a global variable of this name also exists in JLD2. Stacktrace: [1] top-level scope @ basic_usage.md:91 [2] eval @ ./boot.jl:430 [inlined] [3] #60 @ ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:803 [inlined] [4] cd(f::Documenter.var"#60#62"{Module, Expr}, dir::String) @ Base.Filesystem ./file.jl:112 [5] (::Documenter.var"#59#61"{Documenter.Page, Module, Expr})() @ Documenter ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:802 [6] (::IOCapture.var"#5#9"{DataType, Documenter.var"#59#61"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}})() @ IOCapture ~/.julia/packages/IOCapture/Y5rEA/src/IOCapture.jl:170 [7] with_logstate(f::IOCapture.var"#5#9"{DataType, Documenter.var"#59#61"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}}, logstate::Base.CoreLogging.LogState) @ Base.CoreLogging ./logging/logging.jl:522 [8] with_logger(f::Function, logger::Base.CoreLogging.ConsoleLogger) @ Base.CoreLogging ./logging/logging.jl:632 [9] capture(f::Documenter.var"#59#61"{Documenter.Page, Module, Expr}; rethrow::Type, color::Bool, passthrough::Bool, capture_buffer::IOBuffer, io_context::Vector{Any}) @ IOCapture ~/.julia/packages/IOCapture/Y5rEA/src/IOCapture.jl:167 [10] runner(::Type{Documenter.Expanders.ExampleBlocks}, node::MarkdownAST.Node{Nothing}, page::Documenter.Page, doc::Documenter.Document) @ Documenter ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:801
Documentation: ../../../.julia/packages/Documenter/Bs999/src/utilities/utilities.jl#L44
failed to run `@example` block in src/basic_usage.md:99-101 ```@example save("example.jld2", "mygroup/mystuff", 42) ``` exception = UndefVarError: `save` not defined in `Main.__atexample__237` Suggestion: check for spelling errors or missing imports. Hint: a global variable of this name may be made accessible by importing FileIO in the current active module Main Hint: a global variable of this name also exists in JLD2. Stacktrace: [1] top-level scope @ basic_usage.md:100 [2] eval @ ./boot.jl:430 [inlined] [3] #60 @ ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:803 [inlined] [4] cd(f::Documenter.var"#60#62"{Module, Expr}, dir::String) @ Base.Filesystem ./file.jl:112 [5] (::Documenter.var"#59#61"{Documenter.Page, Module, Expr})() @ Documenter ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:802 [6] (::IOCapture.var"#5#9"{DataType, Documenter.var"#59#61"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}})() @ IOCapture ~/.julia/packages/IOCapture/Y5rEA/src/IOCapture.jl:170 [7] with_logstate(f::IOCapture.var"#5#9"{DataType, Documenter.var"#59#61"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}}, logstate::Base.CoreLogging.LogState) @ Base.CoreLogging ./logging/logging.jl:522 [8] with_logger(f::Function, logger::Base.CoreLogging.ConsoleLogger) @ Base.CoreLogging ./logging/logging.jl:632 [9] capture(f::Documenter.var"#59#61"{Documenter.Page, Module, Expr}; rethrow::Type, color::Bool, passthrough::Bool, capture_buffer::IOBuffer, io_context::Vector{Any}) @ IOCapture ~/.julia/packages/IOCapture/Y5rEA/src/IOCapture.jl:167 [10] runner(::Type{Documenter.Expanders.ExampleBlocks}, node::MarkdownAST.Node{Nothing}, page::Documenter.Page, doc::Documenter.Document) @ Documenter ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:801
Documentation: ../../../.julia/packages/Documenter/Bs999/src/utilities/utilities.jl#L44
failed to run `@example` block in src/basic_usage.md:105-109 ```@example jldopen("example.jld2") do file file["mygroup"]["mystuff"] end ``` exception = UndefVarError: `jldopen` not defined in `Main.__atexample__238` Suggestion: check for spelling errors or missing imports. Hint: a global variable of this name also exists in JLD2. Stacktrace: [1] top-level scope @ basic_usage.md:106 [2] eval @ ./boot.jl:430 [inlined] [3] #60 @ ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:803 [inlined] [4] cd(f::Documenter.var"#60#62"{Module, Expr}, dir::String) @ Base.Filesystem ./file.jl:112 [5] (::Documenter.var"#59#61"{Documenter.Page, Module, Expr})() @ Documenter ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:802 [6] (::IOCapture.var"#5#9"{DataType, Documenter.var"#59#61"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}})() @ IOCapture ~/.julia/packages/IOCapture/Y5rEA/src/IOCapture.jl:170 [7] with_logstate(f::IOCapture.var"#5#9"{DataType, Documenter.var"#59#61"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}}, logstate::Base.CoreLogging.LogState) @ Base.CoreLogging ./logging/logging.jl:522 [8] with_logger(f::Function, logger::Base.CoreLogging.ConsoleLogger) @ Base.CoreLogging ./logging/logging.jl:632 [9] capture(f::Documenter.var"#59#61"{Documenter.Page, Module, Expr}; rethrow::Type, color::Bool, passthrough::Bool, capture_buffer::IOBuffer, io_context::Vector{Any}) @ IOCapture ~/.julia/packages/IOCapture/Y5rEA/src/IOCapture.jl:167 [10] runner(::Type{Documenter.Expanders.ExampleBlocks}, node::MarkdownAST.Node{Nothing}, page::Documenter.Page, doc::Documenter.Document) @ Documenter ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:801
Documentation: ../../../.julia/packages/Documenter/Bs999/src/utilities/utilities.jl#L44
failed to run `@example` block in src/basic_usage.md:113-115 ```@example load("example.jld2", "mygroup/mystuff") ``` exception = UndefVarError: `load` not defined in `Main.__atexample__239` Suggestion: check for spelling errors or missing imports. Hint: a global variable of this name may be made accessible by importing FileIO in the current active module Main Hint: a global variable of this name also exists in JLD2. Stacktrace: [1] top-level scope @ basic_usage.md:114 [2] eval @ ./boot.jl:430 [inlined] [3] #60 @ ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:803 [inlined] [4] cd(f::Documenter.var"#60#62"{Module, Expr}, dir::String) @ Base.Filesystem ./file.jl:112 [5] (::Documenter.var"#59#61"{Documenter.Page, Module, Expr})() @ Documenter ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:802 [6] (::IOCapture.var"#5#9"{DataType, Documenter.var"#59#61"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}})() @ IOCapture ~/.julia/packages/IOCapture/Y5rEA/src/IOCapture.jl:170 [7] with_logstate(f::IOCapture.var"#5#9"{DataType, Documenter.var"#59#61"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}}, logstate::Base.CoreLogging.LogState) @ Base.CoreLogging ./logging/logging.jl:522 [8] with_logger(f::Function, logger::Base.CoreLogging.ConsoleLogger) @ Base.CoreLogging ./logging/logging.jl:632 [9] capture(f::Documenter.var"#59#61"{Documenter.Page, Module, Expr}; rethrow::Type, color::Bool, passthrough::Bool, capture_buffer::IOBuffer, io_context::Vector{Any}) @ IOCapture ~/.julia/packages/IOCapture/Y5rEA/src/IOCapture.jl:167 [10] runner(::Type{Documenter.Expanders.ExampleBlocks}, node::MarkdownAST.Node{Nothing}, page::Documenter.Page, doc::Documenter.Document) @ Documenter ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:801
Documentation: ../../../.julia/packages/Documenter/Bs999/src/utilities/utilities.jl#L44
failed to run `@example` block in src/basic_usage.md:128-136 ```@example using UnPack file = jldopen("example.jld2", "w") x, y = rand(2) @pack! file = x, y # equivalent to file["x"] = x; file["y"] = y @unpack x, y = file # equivalent to x = file["x"]; y = file["y"] close(file) ``` exception = UndefVarError: `jldopen` not defined in `Main.__atexample__241` Suggestion: check for spelling errors or missing imports. Hint: a global variable of this name also exists in JLD2. Stacktrace: [1] top-level scope @ basic_usage.md:130 [2] eval @ ./boot.jl:430 [inlined] [3] #60 @ ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:803 [inlined] [4] cd(f::Documenter.var"#60#62"{Module, Expr}, dir::String) @ Base.Filesystem ./file.jl:112 [5] (::Documenter.var"#59#61"{Documenter.Page, Module, Expr})() @ Documenter ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:802 [6] (::IOCapture.var"#5#9"{DataType, Documenter.var"#59#61"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}})() @ IOCapture ~/.julia/packages/IOCapture/Y5rEA/src/IOCapture.jl:170 [7] with_logstate(f::IOCapture.var"#5#9"{DataType, Documenter.var"#59#61"{Documenter.Page, Module, Expr}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}, IOContext{Base.PipeEndpoint}}, logstate::Base.CoreLogging.LogState) @ Base.CoreLogging ./logging/logging.jl:522 [8] with_logger(f::Function, logger::Base.CoreLogging.ConsoleLogger) @ Base.CoreLogging ./logging/logging.jl:632 [9] capture(f::Documenter.var"#59#61"{Documenter.Page, Module, Expr}; rethrow::Type, color::Bool, passthrough::Bool, capture_buffer::IOBuffer, io_context::Vector{Any}) @ IOCapture ~/.julia/packages/IOCapture/Y5rEA/src/IOCapture.jl:167 [10] runner(::Type{Documenter.Expanders.ExampleBlocks}, node::MarkdownAST.Node{Nothing}, page::Documenter.Page, doc::Documenter.Document) @ Documenter ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:801
Documentation
Process completed with exit code 1.
Documentation: ../../../.julia/packages/Documenter/Bs999/src/utilities/utilities.jl#L46
Cannot resolve @ref for md"[`jlread`](@ref)" in src/internals.md. - No docstring found in doc for binding `JLD2.jlread`. - No docstring found in doc for binding `Main.jlread`.
Documentation: ../../../.julia/packages/Documenter/Bs999/src/utilities/utilities.jl#L46
Cannot resolve @ref for md"[`jlread`](@ref)" in src/internals.md. - No docstring found in doc for binding `JLD2.jlread`. - No docstring found in doc for binding `Main.jlread`.
Documentation: ../../../.julia/packages/Documenter/Bs999/src/utilities/utilities.jl#L46
Cannot resolve @ref for md"[`JLD2.writeas`](@ref)" in src/internals.md. - No docstring found in doc for binding `JLD2.writeas`. - No docstring found in doc for binding `JLD2.writeas`.