Skip to content

Fix syntax in example in documentation #238

Fix syntax in example in documentation

Fix syntax in example in documentation #238

Triggered via pull request July 18, 2024 15:04
@nhz2nhz2
synchronize #392
patch-1
Status Success
Total duration 2m 54s
Artifacts

Documenter.yml

on: pull_request
Fit to window
Zoom out
Zoom in

Annotations

2 errors, 1 warning, and 1 notice
Documentation: ../../../.julia/packages/Documenter/bFHi4/src/Documenter.jl#L556
Git failed to fetch git@github.com:JuliaIO/FileIO.jl.git This can be caused by a DOCUMENTER_KEY variable that is not correctly set up. Make sure that the environment variable is properly set up as a Base64-encoded string of the SSH private key. You may need to re-generate the keys with DocumenterTools.
Documentation: ../../../.julia/packages/Documenter/bFHi4/src/Documenter.jl#L664
Failed to push: exception = failed process: Process(`git fetch upstream`, ProcessExited(128)) [128] Stacktrace: [1] pipeline_error @ ./process.jl:565 [inlined] [2] run(::Cmd; wait::Bool) @ Base ./process.jl:480 [3] run @ ./process.jl:477 [inlined] [4] (::Documenter.var"#git_commands#27"{String, String, SubString{String}, String, Vector{Any}, Bool, String, String})(sshconfig::String) @ Documenter ~/.julia/packages/Documenter/bFHi4/src/Documenter.jl:554 [5] (::Documenter.var"#26#32"{String})() @ Documenter ~/.julia/packages/Documenter/bFHi4/src/Documenter.jl:659 [6] cd(f::Documenter.var"#26#32"{String}, dir::String) @ Base.Filesystem ./file.jl:112 [7] #25 @ ~/.julia/packages/Documenter/bFHi4/src/Documenter.jl:659 [inlined] [8] withenv(f::Documenter.var"#25#31"{String, String}, keyvals::Pair{String, String}) @ Base ./env.jl:257 [9] (::Documenter.var"#24#30"{String, String, SubString{String}, String})(sshconfig::String, io::IOStream) @ Documenter ~/.julia/packages/Documenter/bFHi4/src/Documenter.jl:658 [10] mktemp(fn::Documenter.var"#24#30"{String, String, SubString{String}, String}, parent::String) @ Base.Filesystem ./file.jl:738 [11] mktemp(fn::Function) @ Base.Filesystem ./file.jl:736 [12] git_push(root::String, temp::String, repo::String; branch::String, dirname::String, target::String, sha::SubString{String}, devurl::String, versions::Vector{Any}, forcepush::Bool, deploy_config::Documenter.GitHubActions, subfolder::String, is_preview::Bool) @ Documenter ~/.julia/packages/Documenter/bFHi4/src/Documenter.jl:643 [13] git_push @ ~/.julia/packages/Documenter/bFHi4/src/Documenter.jl:530 [inlined] [14] #18 @ ~/.julia/packages/Documenter/bFHi4/src/Documenter.jl:508 [inlined] [15] mktempdir(fn::Documenter.var"#18#20"{SubString{String}, String, String, String, String, Vector{Any}, Bool, Documenter.GitHubActions, Bool, String, String, String}, parent::String; prefix::String) @ Base.Filesystem ./file.jl:766 [16] mktempdir(fn::Function, parent::String) @ Base.Filesystem ./file.jl:762 [17] mktempdir @ ./file.jl:762 [inlined] [18] (::Documenter.var"#17#19"{String, String, String, Nothing, String, Vector{Any}, Bool, Documenter.GitHubActions, Bool, String, String, String})() @ Documenter ~/.julia/packages/Documenter/bFHi4/src/Documenter.jl:507 [19] cd(f::Documenter.var"#17#19"{String, String, String, Nothing, String, Vector{Any}, Bool, Documenter.GitHubActions, Bool, String, String, String}, dir::String) @ Base.Filesystem ./file.jl:112 [20] deploydocs(; root::String, target::String, dirname::String, repo::String, branch::String, repo_previews::String, branch_previews::String, deps::Nothing, make::Nothing, devbranch::String, devurl::String, versions::Vector{Any}, forcepush::Bool, deploy_config::Documenter.GitHubActions, push_preview::Bool) @ Documenter ~/.julia/packages/Documenter/bFHi4/src/Documenter.jl:484 [21] top-level scope @ ~/work/FileIO.jl/FileIO.jl/docs/make.jl:20 [22] include(fname::String) @ Base.MainInclude ./client.jl:489 [23] top-level scope @ none:8 [24] eval @ ./boot.jl:385 [inlined] [25] exec_options(opts::Base.JLOptions) @ Base ./client.jl:291 [26] _start() @ Base ./client.jl:552
Documentation: ../../../.julia/packages/Documenter/bFHi4/src/DocChecks.jl#L69
5 docstrings not included in the manual: FileIO.handle_exceptions :: Tuple{Vector, Any} FileIO.detectisom :: Tuple{Any} FileIO.LoaderError FileIO.WriterError FileIO.info :: Tuple{Union{Type, Formatted}} These are docstrings in the checked modules (configured with the modules keyword) that are not included in @docs or @autodocs blocks.
[julia-buildpkg] Caching of the julia depot was not detected
Consider using `julia-actions/cache` to speed up runs https://github.com/julia-actions/cache. To ignore, set input `ignore-no-cache: true`