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.

Sign up for GitHub

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

Jump to bottom

API documentation #101

Closed
robin-snt opened this issue Dec 2, 2019 · 1 comment
Closed

API documentation #101

robin-snt opened this issue Dec 2, 2019 · 1 comment
Labels
area/documentation Documentation related issues. kind/enhancement Something could be better. status/accepted We were able to reproduce the issue and accept to work on it.

Comments

@robin-snt
Copy link
Contributor

Please create a sphinx generated API definition.

The readme and examples are not sufficient to understand how this client works. It would be extremely helpful if there at least an API overview, where the classes and functions were clearly defined in terms of input and output. E.g: https://2.python-requests.org/en/master/api/#main-interface
@sleto-it sleto-it added area/documentation Documentation related issues. kind/enhancement Something could be better. status/accepted We were able to reproduce the issue and accept to work on it. labels Feb 26, 2020
@minhaj-shakeel
Copy link
Contributor

Github issues have been deprecated.
This issue has been moved to discuss. You can follow the conversation there and also subscribe to updates by changing your notification preferences.

drawing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/documentation Documentation related issues. kind/enhancement Something could be better. status/accepted We were able to reproduce the issue and accept to work on it.
Milestone
No milestone
Development

No branches or pull requests
3 participants
@sleto-it @minhaj-shakeel @robin-snt