Skip to content

docs: update method docstrings #680

docs: update method docstrings

docs: update method docstrings #680

Triggered via pull request November 4, 2024 20:57
@oameyeoameye
synchronize #311
oameye-patch-1
Status Success
Total duration 16m 49s
Artifacts

Documentation.yml

on: pull_request
Fit to window
Zoom out
Zoom in

Annotations

10 warnings
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/utilities/utilities.jl#L46
111 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{Num, ComplexF64}, HarmonicBalance.Result} HarmonicBalance.plot_1D_solutions_branch :: Tuple{Int64, HarmonicBalance.Result} HarmonicBalance.ExprUtils._fourier_term :: NTuple{4, Any} HarmonicBalance.ExprUtils.expand_all :: Tuple{Any} HarmonicBalance.sort_1D :: Tuple{Vector{Vector{Vector{ComplexF64}}}} HarmonicBalance._prepare_input_params :: Tuple{HarmonicBalance.Problem, OrderedCollections.OrderedDict{Num, Vector{Union{Float64, ComplexF64}}}, OrderedCollections.OrderedDict{Num, Float64}} HarmonicBalance.LinearResponse._pair_to_peaks :: Tuple{Any, Vector} HarmonicBalance.alg_specific_options :: Tuple{WarmUp} HarmonicBalance.alg_specific_options :: Tuple{TotalDegree} HarmonicBalance.alg_specific_options :: Tuple{Polyhedral} HarmonicBalance.HC_wrapper.declare_variable :: Tuple{String} HarmonicBalance.classify_branch :: Tuple{HarmonicBalance.Result, Int64, String} HarmonicBalance.is_repetitive :: Tuple{Any} HarmonicBalance.FFTWExt.FFT :: Tuple{Any, Any} HarmonicBalance.LinearResponse._simplify_spectrum :: Tuple{HarmonicBalance.LinearResponse.JacobianSpectrum} 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.LinearResponse.get_implicit_Jacobian :: Tuple{HarmonicEquation} HarmonicBalance.newton :: Tuple{HarmonicBalance.Result, OrderedCollections.OrderedDict} Base.show :: Tuple{IO, Polyhedral} Base.show :: Tuple{IO, WarmUp} Base.show :: Tuple{IO, TotalDegree} 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._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 :: Tuple{HarmonicBalance.Result, Vector{Float64}, Int64} 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.seed :: Tuple{HarmonicBalance.HarmonicBalanceMethod} HarmonicBalance._remove_brackets :: Tuple{HarmonicEquation} HarmonicBalance.LinearResponse._get_uv_pairs :: Tuple{Vector{HarmonicVariable}} HarmonicBalance.alg_default_options :: Tuple{HarmonicBalance.HarmonicBalanceMethod} Symbolics.get_variables :: Tuple{HarmonicEquation} HarmonicBalance.LinearResponse.evaluate :: Tuple{HarmonicBalance.LinearResponse.Lorentzian, Float64} HarmonicBalance.LinearResponse.evaluate :: Tuple{HarmonicBalance.LinearResponse.JacobianSpectrum, Float64} HarmonicBalance.show_fields :: Tuple{Any} HarmonicBalance.H
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#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/C1XEF/src/deploydocs.jl#L533
removing `stable` and linking `stable` to `v0.12.0`.
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/deploydocs.jl#L533
removing `v0.12` and linking `v0.12` to `v0.12.0`.
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/deploydocs.jl#L533
removing `v0.11` and linking `v0.11` to `v0.11.1`.
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/deploydocs.jl#L533
removing `v0.10` and linking `v0.10` to `v0.10.11`.
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/deploydocs.jl#L533
removing `v0.9` and linking `v0.9` to `v0.9.2`.
Documentation: ../../../.julia/packages/Documenter/C1XEF/src/deploydocs.jl#L533
removing `v0.8` and linking `v0.8` to `v0.8.0`.