-
Notifications
You must be signed in to change notification settings - Fork 1
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
Please add API documentation #43
Comments
Hi @wingunder, There is an API description on this page: https://meteoswiss.github.io/ampycloud/running.html Is this the sort of things you had in mind ? The reason I have not put anything in the README is that the above page is directly generated from the Python docstrings, and thus will always remain up-to-date. The content itself can evidently be adjusted, if you find anything missing/unclear/confusing/convoluted. Just let me know. To make it easier to find this information, I would propose to put a new API section in the README with a direct link to that page. Would that be an acceptable fix to this issue ? Side-note: the page above contains the description of the high-level routines that are meant to be used by the ampycloud users. But all the ampycloud functions' docstrings are also included (and thus searchable) in the documentation: https://meteoswiss.github.io/ampycloud/modules.html |
Hi @fpavogt Thanks for the information. Ok, I get it. Ampycloud is a python lib and that's it. The interface is python and at the moment it is expected that interfacing should be done outside of this lib, as I understand it. This is ok with me, but then the interface that I was thinking of (a REST interface), will have to be in a different project. Please confirm if this is accurate. Regards |
Yep, exactly. I added a note in #44 about this as well. |
Thanks, closing. |
At the moment no APIs are documented. These should at least be documented in the top-level README.
It is possible to look at some test cases in order to reverse engineer this, but this is not the preferred way, could change, and takes a lot of effort.
The text was updated successfully, but these errors were encountered: