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

Add API documentation #15

Open
J535D165 opened this issue May 30, 2022 · 2 comments
Open

Add API documentation #15

J535D165 opened this issue May 30, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@J535D165
Copy link
Member

The datatools package has an intuitive API. At the moment, only the CLI is documented. We are welcoming contributions to the documentation that describe the API.
@J535D165 J535D165 added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels May 30, 2022
@arav-k
Copy link

arav-k commented Jun 15, 2022

I would like to take up this. Need more details on the same.

@J535D165
Copy link
Member Author

That would be nice. Please let me know if there is anything I can help with. Maybe a nice starting point is the API documentation of Insights https://github.com/asreview/asreview-insights#plotting-api. Small examples of usage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@J535D165 @arav-k