Proposal for Parameter Sorting in Classes/Functions
Background:
In our current implementation, the parameters for classes/functions are sorted in the following order:
-
Atomgroup(positional) - General base parameters (optional, inherited from
AnalysisBase - Geometric base parameters (optional, inherited from
ProfilePlanarBaseor similar classes) - Module-specific parameters (optional)
Issue:
This ordering may not be optimal for our users, as they often need to modify the module-specific parameters more frequently than the general or geometric base parameters.
Suggestion:
I propose we update the sorting order of parameters to prioritize user needs. The new proposed order is:
-
Atomgroup(positional) - Module-specific parameters (optional)
- Geometric base parameters (optional)
- General base parameters (optional)
Implementation:
We should ensure that the parameters in the code are sorted in the same way as they are documented. This will maintain consistency and improve usability.