Analysis classes code consistency (parameter names and other conventions, etc.)
Description
This issue was created so that we can fix issues with code consistency and naming conventions across the various different analysis classes.
Motivation
Any issues relating to code style, naming conventions and consistency in the analysis classes will be discussed here, and addressed on one big merge request, instead of dealing with them ad hoc in different merge requests. These issues will be ignored when merging !180 (merged), !177 (merged), !167 (merged) and !176 (merged), so that they can be addressed in one go later. So far a number of issues have been raised in !176 (merged):
-
Naming variables according to snake case convention and not using abbreviations !176 (comment 574904672) !176 (comment 574904675) !176 (comment 574904679) !176 (comment 574904690) !176 (comment 575006594) !176 (comment 574985377) -
Using xarray dataset interface correctly !176 (comment 574904684) -
Use latest functions in figure plotting !176 (comment 574985371) -
Do text wrapping of figure captions properly !176 (comment 574985380) -
Do docstrings correctly !176 (comment 574985389) !176 (comment 574985393) -
(Added by @caenrigen) Show analysis figure results in the docs for each analysis, !178 (closed) has some
request @caenrigen @kel85uk @AdriaanRol If anyone has any other issues they would like to raise that relate to consistency across analysis classes, can you please raise them here and I will address them in the big merge request.