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

Cannot find API documentation #1

Closed
kbarnhart opened this issue Sep 24, 2018 · 1 comment
Closed

Cannot find API documentation #1

kbarnhart opened this issue Sep 24, 2018 · 1 comment

Comments

@kbarnhart
Copy link

As part of my JOSS review I have looked for API documentation (review standards listed here).

I have found an excellent description of the eSCAPE input file here. And looking at the source code I see that docstrings have been written for the major public-facing functions.

However, I have not found API documentation. As this is one of the review requirements, I'd recommend making more easily visible.

@tristan-salles
Copy link
Member

I have updated the website and wiki with link to the API documentation:
https://escape-api.github.io/index.html

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

2 participants