Skip to content

style: Better docstrings #744

style: Better docstrings

style: Better docstrings #744

Triggered via pull request November 20, 2024 22:17
Status Success
Total duration 17m 13s
Artifacts

Documentation.yml

on: pull_request
Fit to window
Zoom out
Zoom in

Annotations

10 warnings
Documentation: ../../../.julia/packages/Documenter/Bs999/src/utilities/utilities.jl#L46
failed to run `@example` block in src/examples/parametron.md:71-74 ```@example parametron HarmonicBalance.save("parametron_result.jld2", result); nothing #hide ``` exception = setfield!: immutable struct of type Result cannot be changed Stacktrace: [1] setproperty!(x::HarmonicBalance.Result{ComplexF64, Float64, 1, FunctionWrappers.FunctionWrapper{Matrix{ComplexF64}, Tuple{Vector{ComplexF64}}}, Matrix{Num}}, f::Symbol, v::Function) @ Base ./Base.jl:53 [2] save(filename::String, x::HarmonicBalance.Result{ComplexF64, Float64, 1, FunctionWrappers.FunctionWrapper{Matrix{ComplexF64}, Tuple{Vector{ComplexF64}}}, Matrix{Num}}) @ HarmonicBalance ~/work/HarmonicBalance.jl/HarmonicBalance.jl/src/saving.jl:16 [3] top-level scope @ parametron.md:72 [4] eval @ ./boot.jl:430 [inlined] [5] #60 @ ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:803 [inlined] [6] cd(f::Documenter.var"#60#62"{Module, Expr}, dir::String) @ Base.Filesystem ./file.jl:112 [7] (::Documenter.var"#59#61"{Documenter.Page, Module, Expr})() @ Documenter ~/.julia/packages/Documenter/Bs999/src/expander_pipeline.jl:802 [8] (::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 [9] 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 [10] with_logger(f::Function, logger::Base.CoreLogging.ConsoleLogger) @ Base.CoreLogging ./logging/logging.jl:632 [11] 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 [12] 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#L46
126 docstrings not included in the manual: HarmonicBalance.ExprUtils.count_derivatives :: Tuple{SymbolicUtils.BasicSymbolic} HarmonicBalance.to_lab_frame :: Tuple{OrderedCollections.OrderedDict, HarmonicBalance.Result, Num, Any} HarmonicBalance.is_Hopf_unstable :: Tuple{OrderedCollections.OrderedDict, HarmonicBalance.Result} HarmonicBalance.plot_1D_solutions_branch :: Tuple{Int64, HarmonicBalance.Result} HarmonicBalance.ExprUtils._fourier_term :: NTuple{4, Any} HarmonicBalance.LimitCycles._gaugefixed_Jacobian :: Tuple{HarmonicEquation, HarmonicVariable} HarmonicBalance.ExprUtils.expand_all :: Tuple{Any} HarmonicBalance.sort_1D :: Union{Tuple{Union{Array{Array{Vector{T}, 1}, 1}, Array{Array{Vector{T}, 1}, 2}}}, Tuple{T}} where T<:Number HarmonicBalance._prepare_input_params :: Tuple{HarmonicBalance.Problem, OrderedCollections.OrderedDict, OrderedCollections.OrderedDict} HarmonicBalance.LinearResponse._pair_to_peaks :: Tuple{Any, Vector} HarmonicBalance.get_class :: Tuple{HarmonicBalance.Result, String} HarmonicBalance.get_class :: Tuple{HarmonicBalance.Result, Int64, String} HarmonicBalance.alg_specific_options :: Tuple{TotalDegree} HarmonicBalance.alg_specific_options :: Tuple{Polyhedral} HarmonicBalance.is_repetitive :: Tuple{Any} HarmonicBalance.FFTWExt.FFT :: Tuple{Any, Any} HarmonicBalance.LinearResponse._simplify_spectrum :: Union{Tuple{HarmonicBalance.LinearResponse.JacobianSpectrum{T}}, Tuple{T}} where T<:Real HarmonicBalance.ExprUtils.is_function :: Tuple{Any, Any} HarmonicBalance.filter_result! :: Tuple{HarmonicBalance.Result, String} HarmonicBalance._get_mask :: Union{Tuple{Any, Any}, Tuple{Any, Any, Any}} HarmonicBalance.rearrange! :: Tuple{HarmonicEquation, Vector{Num}} HarmonicBalance.sort_2D :: Union{Tuple{Union{Array{Array{Vector{T}, 1}, 1}, Array{Array{Vector{T}, 1}, 2}}}, Tuple{T}} where T HarmonicBalance.newton :: Tuple{HarmonicBalance.Result, OrderedCollections.OrderedDict} Base.show :: Tuple{IO, DifferentialEquation} Base.show :: Tuple{DifferentialEquation} Base.show :: Tuple{IO, WarmUp} Base.show :: Tuple{IO, TotalDegree} Base.show :: Tuple{IO, Polyhedral} HarmonicBalance.filter_duplicate_parameters :: Tuple{Any, Any} HarmonicBalance.LimitCycles._cycle_Problem :: Tuple{HarmonicEquation, Num} HarmonicBalance.LinearResponse._simplify_spectra! :: Tuple{Dict{Num, HarmonicBalance.LinearResponse.JacobianSpectrum}} HarmonicBalance.LimitCycles.get_limit_cycles :: Tuple{HarmonicEquation, Any, Any, Any} HarmonicBalance.ExprUtils.is_trig :: Tuple{Num} HarmonicBalance.get_nn_2D :: Tuple{Vector{Int64}, Int64, Int64} HarmonicBalance._parameters :: Tuple{HarmonicEquation} HarmonicBalance.ExprUtils.isexp :: Tuple{Any} HarmonicBalance.LimitCycles.add_pairs! :: Tuple{DifferentialEquation} HarmonicBalance.classify_binaries! :: Tuple{HarmonicBalance.Result} HarmonicBalance.thread :: Tuple{HarmonicBalance.HarmonicBalanceMethod} HarmonicBalance.LimitCycles.get_cycle_variables :: Tuple{HarmonicEquation, Num} HarmonicBalance.method_symbol :: Tuple{TotalDegree} HarmonicBalance.method_symbol :: Tuple{Polyhedral} TimeEvolution._closest_branch_index :: Union{Tuple{P}, Tuple{S}, Tuple{HarmonicBalance.Result{S, ParType, D, F} where {ParType<:Number, D, F<:FunctionWrappers.FunctionWrapper{Matrix{S}, Tuple{Vector{S}}}}, Vector{P}, Int64}} where {S, P} HarmonicBalance.get_implicit_Jacobian :: Tuple{HarmonicEquation} HarmonicBalance._classify_default! :: Tuple{Any} HarmonicBalance.ExprUtils.fourier_sin_term :: Tuple{Any, Any, Any} HarmonicBalance.LinearResponse._get_as :: Tuple{Vector{HarmonicVariable}} HarmonicBalance.rearrange_standard :: Tuple{HarmonicEquation} HarmonicBalance.ExprUtils.add_div :: Tuple{Any} HarmonicBalance.var_name :: Tuple{Num} HarmonicBalance.remove_rows_columns :: Tuple{Matrix, Vector{Int64}, Vector{Int64}} HarmonicBalance._is_stable :: Tuple{Any, Any} HarmonicBalance._is_stable :: Tuple{HarmonicBalan
Documentation: ../../../.julia/packages/DocumenterVitepress/8qgu7/src/vitepress_config.jl#L111
DocumenterVitepress: No logo.png file found in `docs/src/assets`. Skipping logo replacement.
Documentation: ../../../.julia/packages/DocumenterVitepress/8qgu7/src/writer.jl#L702
DocumenterVitepress: un-expanded `@example parametron` block encountered on page src/examples/parametron.md. The first few lines of code in this node are: ``` HarmonicBalance.save("parametron_result.jld2", result); nothing #hide ```
Documentation: ../../../.julia/packages/DocumenterVitepress/8qgu7/src/writer.jl#L488
DocumenterVitepress: Unknown MIME type text/latex provided and no alternatives given. Ignoring render!
Documentation: ../../../.julia/packages/DocumenterVitepress/8qgu7/src/writer.jl#L488
DocumenterVitepress: Unknown MIME type text/latex provided and no alternatives given. Ignoring render!
Documentation: ../../../.julia/packages/Documenter/Bs999/src/deploydocs.jl#L552
removing `stable` and linking `stable` to `v0.12.1`.
Documentation: ../../../.julia/packages/Documenter/Bs999/src/deploydocs.jl#L552
removing `v0.12` and linking `v0.12` to `v0.12.1`.
Documentation: ../../../.julia/packages/Documenter/Bs999/src/deploydocs.jl#L552
removing `v0.11` and linking `v0.11` to `v0.11.1`.
Documentation: ../../../.julia/packages/Documenter/Bs999/src/deploydocs.jl#L552
removing `v0.10` and linking `v0.10` to `v0.10.11`.