QMCPACK / QMCPACK/qmcpack

marked up Formulas in class documentation should actual render in doxygen

Open
#4,088 2 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
C++
Stars
403
Forks
154
Avg merge
1d 12h
Merged PRs (30d)
82

Description

It seems like the only place a fair amount of the math used in our implementations is documented is in the actual source. But most of it does not render in our doxygen output since most of it is either bad/incomplete latex or not marked up properly.

see https://doxygen.nl/manual/formulas.html

This is important because there are often significant differences between implementation and them manual or some paper from 5-50 years ago.

**Describe the solution you'd like**
Folks should fix these as they find they're doing work in relevant files. Do it in a small PR before or after your significant work. It will help your metrics.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.