ENH: Add documentation for generic indices
bzah opened this issue · 0 comments
bzah commented
PR #189 is already way too long but still lack proper documentation.
We should try to document each of the generic indicators with:
- A definition
- One example per specific use case (difference_of_means has several cases)
- A link to the ECAD indices
- A user documentation for the
Thresholdclass
Additionally, for future development purposes, it is necessary to document the following classes/modules:
- ClimateVariable
- StandardVariable
- Indicator, ResamplingIndicator, GenericIndicator
- Frequency
- Operator
- Registry