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

Document API #11

Open
irony opened this issue Jan 17, 2022 · 0 comments
Open

Document API #11

irony opened this issue Jan 17, 2022 · 0 comments

Comments

@irony
Copy link
Contributor

irony commented Jan 17, 2022

By adding annotations to the properties in the API we can create an API that is easy to understand. Right now it's a lot of boilerplate and default values. By removing unnecessary methods and adding examples and descriptions we can make the API easier for new developers to understand.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@irony