pysep icon indicating copy to clipboard operation
pysep copied to clipboard

better documentation on PySEP argument options

Open bch0w opened this issue 2 years ago • 1 comments

Related to #118, some argument inputs of PySEP like write_files and plot_files are not covered in the documentation, and only really visible in the direct docstrings of the source code. Since it's not expected that every User will be looking at source code doc strings, we should make some more transparent documentation that exposes the expected API of these less-than-intuitive parameters.

bch0w avatar Aug 28 '23 19:08 bch0w

Just adding to this, it will be really helpful to have a full list of **kwargs for both pysep and recsec, that will effectively be used by the source code.

aakash10gupta avatar Apr 12 '25 20:04 aakash10gupta