Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

better documentation on PySEP argument options #119

Open
bch0w opened this issue Aug 28, 2023 · 0 comments
Open

better documentation on PySEP argument options #119

bch0w opened this issue Aug 28, 2023 · 0 comments
Milestone

Comments

@bch0w
Copy link
Member

bch0w commented Aug 28, 2023

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 bch0w added this to the PySEP v0.6.0 milestone Nov 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant