JuliaAtoms / EnergyExpressions.jl

Other
1 stars 1 forks source link

Use newest Documenter for docs #15

Closed mortenpi closed 2 years ago

mortenpi commented 2 years ago

There are also a few docstrings that are not included in the manual right now:

┌ Warning: 6 docstrings not included in the manual:
│ 
│     EnergyExpressions.coupled_states :: Tuple{SparseArrays.AbstractSparseMatrix{Tv, Ti} where {Tv, Ti}}
│     LinearAlgebra.ishermitian :: Tuple{QuantumOperator}
│     EnergyExpressions.non_zero_cofactors :: Tuple{BitConfigurations, Any, Any, Any}
│     Base.isapprox :: Tuple{EnergyExpressions.NBodyMatrixElement, EnergyExpressions.NBodyMatrixElement}
│     EnergyExpressions.compare :: Tuple{EnergyExpressions.NBodyMatrixElement, Any, EnergyExpressions.NBodyMatrixElement}
│     Base.:== :: Tuple{EnergyExpressions.NBodyMatrixElement, EnergyExpressions.NBodyMatrixElement}
│ 
│ These are docstrings in the checked modules (configured with the modules keyword)
│ that are not included in @docs or @autodocs blocks.
└ @ Documenter.DocChecks ~/.julia/packages/Documenter/Eieg5/src/Utilities/Utilities.jl:41
codecov[bot] commented 2 years ago

Codecov Report

Merging #15 (ec2ec58) into master (49eb810) will increase coverage by 0.43%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master      #15      +/-   ##
==========================================
+ Coverage   23.01%   23.45%   +0.43%     
==========================================
  Files          14       14              
  Lines         808      857      +49     
==========================================
+ Hits          186      201      +15     
- Misses        622      656      +34     
Impacted Files Coverage Δ
src/slater_determinants.jl 11.11% <0.00%> (-0.89%) :arrow_down:
src/nbody_operators.jl 5.76% <0.00%> (-0.24%) :arrow_down:
src/minors.jl 100.00% <0.00%> (ø)
src/variations.jl 0.00% <0.00%> (ø)
src/invariant_sets.jl 0.00% <0.00%> (ø)
src/multi_configurational_equations.jl 0.00% <0.00%> (ø)
src/bit_configurations.jl 4.11% <0.00%> (+0.18%) :arrow_up:
src/nbody_matrix_elements.jl 40.00% <0.00%> (+0.68%) :arrow_up:
src/conjugate_orbitals.jl 71.42% <0.00%> (+4.76%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 49eb810...ec2ec58. Read the comment docs.

mortenpi commented 2 years ago

:tada: http://juliaatoms.org/EnergyExpressions.jl/previews/PR15/

jagot commented 2 years ago

Thanks!