Updating the docs - Githubissues

callat-qcd / lattedb

Lattice QCD database interface using EspressoDB as the content manager.

https://ithems.lbl.gov/lattedb

BSD 3-Clause "New" or "Revised" License

1 stars 0 forks source link

Updating the docs #44

Closed ckoerber closed 4 years ago

ckoerber commented 4 years ago

We should go through all the app models and update the doc strings.

This affects the documentation pages like: https://ithems.lbl.gov/lattedb/documentation/status/.

Apps to check

[x] status
[x] fermionaction
[x] gaugeaction
[x] gaugeconfig
[x] linksmear
[x] propagator
[x] wavefunction
[x] quarksmear
[x] current
[x] correlator
[x] ensemble
[x] project.ga_q2
[x] project.fhcompare
[x] project.formfac

Things to update

The module doc string should summarize all the tables we find in this app
The model doc string should be a verbose description of what this class represents
The field help text should be a verbose description of the field. In particular we should avoid redundant information. E.g., the field type and optionality is auto parsed and does not have to be in the help string:

ckoerber commented 4 years ago

Closed with PR #51