analysis.rst, codingday

[davidsean]

Fixes #1494

Description of changes:

• moved/wrote descriptions to docstring
• fixed a few bugs
• flagged (still) unsupported methods
• need to delete methods which will never be supported
• unit test for chain routines (calc_rg, calc_re, calc_rh)

PR Checklist

• Tests?
  • Interface
  • Core
• Docs?

[codecov]

Codecov Report

Merging #1565 into python will decrease coverage by 9.22%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           python    #1565      +/-   ##
==========================================
- Coverage   43.99%   34.76%   -9.23%     
==========================================
  Files         375      269     -106     
  Lines       29014    15057   -13957     
  Branches     5425     2790    -2635     
==========================================
- Hits        12765     5235    -7530     
+ Misses      16224     9790    -6434     
- Partials       25       32       +7

Impacted Files	Coverage Δ
src/core/minimize_energy.cpp	0% <0%> (-100%)	⬇️
src/core/lattice.hpp	0% <0%> (-100%)	⬇️
src/core/mmm-common.cpp	0% <0%> (-100%)	⬇️
src/core/shapes/Sphere.hpp	0% <0%> (-100%)	⬇️
src/core/utils.cpp	0% <0%> (-100%)	⬇️
src/script_interface/shapes/Wall.hpp	0% <0%> (-100%)	⬇️
src/script_interface/shapes/Sphere.hpp	0% <0%> (-100%)	⬇️
src/core/observables/MagneticDipoleMoment.hpp	0% <0%> (-100%)	⬇️
src/core/correlators/Correlator.hpp	0% <0%> (-100%)	⬇️
src/core/constraints/HomogeneousMagneticField.cpp	0% <0%> (-100%)	⬇️
... and 270 more

---

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 5ad1efb...81f2626. Read the comment docs.