@davelee2804, @nicholasloveday, @tennlee - the API docstrings for Energy budget and Energy exchanges contain formulae, but don't provide a description of what the variables stand for underneath the formulae. Some of the variables seem to be specified in the args. But some are not - for instance, in Energy budgets, what do "g" and "Cp" (I don't know how to do subscript in GitHub issues) stand for?
Some of the other docstrings include a dot point list describing the variables immediately underneath the formulae - e.g see the KGE docstring and the Percent within X docstring.
Should a description of the variables be added underneath the formulae in the energy budgets and energy exchanges docstrings?
@davelee2804, @nicholasloveday, @tennlee - the API docstrings for Energy budget and Energy exchanges contain formulae, but don't provide a description of what the variables stand for underneath the formulae. Some of the variables seem to be specified in the args. But some are not - for instance, in Energy budgets, what do "g" and "Cp" (I don't know how to do subscript in GitHub issues) stand for?
Some of the other docstrings include a dot point list describing the variables immediately underneath the formulae - e.g see the KGE docstring and the Percent within X docstring.
Should a description of the variables be added underneath the formulae in the energy budgets and energy exchanges docstrings?