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

Fill in missing documentation #178

Open

koraa opened this issue Apr 16, 2021 · 1 comment

Labels

documentation enhancement good first issue help wanted

Contributor

koraa commented Apr 16, 2021 •

edited

Not every function of the library is currently documented and some are not up to the level of quality expected from the library.

We should first check of functions that lack API documentation entirely and then fill in cases where documentation is present but not complete.

Every function, class and other structure should have:

A text description
Examples
Version info

koraa added the enhancement label

koraa added documentation good first issue help wanted labels

mshaanminglim commented Jun 15, 2021

Hi iis this a REST API? If it is, I would like to help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment