docs for analysis class
Explanation of changes
Provides documentation for the analysis framework, what the analysis class is, and how it is intended to be used. Addresses (part of) #177 (closed).
Motivation of changes
A key deliverable for the 0.4.0 release.
Merge checklist
See also merge request guidelines
-
Merge request has been reviewed and approved by a project maintainer. -
Merge request contains a clear description of the proposed changes and the issue it addresses. -
Merge request made onto appropriate branch (develop for most MRs). -
New code is fully tested. -
New code is documented and docstrings use numpydoc format. -
CI pipelines pass -
black code-formatting passes (gitlab-ci), -
test suite passes (gitlab-ci), -
no degradation in code-coverage (codacy), -
no (serious) new pylint code quality issues introduced (codacy), -
documentation builds successfully (CI and readthedocs).
-
Edited by Adriaan