pysep icon indicating copy to clipboard operation
pysep copied to clipboard

Readability of available parameters

Open aakash10gupta opened this issue 8 months ago • 2 comments

The constructors of both classes - Pysep and RecordSection, offer a lot of flexibility through the innumerous parameters, both listed in the definition and hidden. The documentation does a good job of clustering the parameters together based on their interdependence. On the other hand the constructor definitions doesn't seem to have this grouping and the parameters here seem to be listed in a random order. It will immensely help the readability and consequently the ease of use of the package if this grouping was brought in the listing of the parameters in the constructor definitions itself.

aakash10gupta avatar May 13 '25 23:05 aakash10gupta

Closing as complete, this will be merged in #167

bch0w avatar Jun 05 '25 18:06 bch0w

The updated order of the full list of available input parameters with their default values can also be reflected in the config file template for convenient usage.

Also, I understand that there is a config file only for downloading data but not for plotting recording sections. Having a standardized template for recsec as well can actually be really useful.

aakash10gupta avatar Jun 11 '25 00:06 aakash10gupta