Documentation

[jrdegreeff]

This PR addresses #40. I have mostly addressed items 2 and 3 on the checklist and have created stubs for items 1 and 4 for @dallasfoster to complete. I am unsure what the existing example system (examples/LJCluster) is, so I have not touched that. This PR shouldn't be merged until all of the TODOs are resolved.

[codecov-commenter]

Codecov Report

Merging #41 (e3220c8) into main (749d79a) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main       #41   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           11        11           
  Lines          154       154           
=========================================
  Hits           154       154           

Impacted Files	Coverage Δ
src/empirical/coulomb.jl	100.00% <ø> (ø)
src/empirical/lj.jl	100.00% <ø> (ø)
src/empirical/morse.jl	100.00% <ø> (ø)
src/empirical/zbl.jl	100.00% <ø> (ø)
src/mixed/linear_combination_potential.jl	100.00% <ø> (ø)
src/empirical/bm.jl	100.00% <100.00%> (ø)
src/nnlist.jl	100.00% <100.00%> (ø)
src/types/abstract_potential.jl	100.00% <100.00%> (ø)
src/types/empirical_potential.jl	100.00% <100.00%> (ø)

---

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 749d79a...e3220c8. Read the comment docs.

[vchuravy]

Can you rebaseon master quickly? I want to make sure that the docs CI job actually runs