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

[JOSS] Doc strings for python api #52

Closed
hgandhi2411 opened this issue Nov 28, 2022 · 1 comment · Fixed by #58
Closed

[JOSS] Doc strings for python api #52

hgandhi2411 opened this issue Nov 28, 2022 · 1 comment · Fixed by #58
Labels
documentation Improvements or additions to documentation

Comments

@hgandhi2411
Copy link

The documentation on thrrmofun.org is good and also has examples. But it would be more accessible if you had doc strings for different methods available. Right now it's hard to tell what methods are available besides those in the example.

@fnattino
Copy link

I agree with @hgandhi2411 that API documentation, as part of both docstrings and online documentation, would be very helpful!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants