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 more extensive documentation (beyond existing README) #55

Closed
vmenger opened this issue Feb 2, 2024 · 2 comments
Closed

Add more extensive documentation (beyond existing README) #55

vmenger opened this issue Feb 2, 2024 · 2 comments
Assignees
@vmenger
Labels
community Regarding community, e.g. docs, guidelines, contact, outreach

Comments

@vmenger
Copy link
Collaborator

vmenger commented Feb 2, 2024

Currently, there is very little documentation beyond the readme. As more users are starting to use clinlp, more extensive documentation is required, both user instructions and docstrings.
@vmenger vmenger added the community Regarding community, e.g. docs, guidelines, contact, outreach label Feb 2, 2024
@vmenger vmenger self-assigned this Apr 17, 2024
@vmenger vmenger changed the title Adding more extensive documentation (beyond readme) Add more extensive documentation (beyond existing README) Apr 17, 2024
@vmenger
Copy link
Collaborator Author

vmenger commented Jun 6, 2024

Made a start in #97 with docstrings and automatically generated API on readthedocs

@vmenger
Copy link
Collaborator Author

vmenger commented Jun 18, 2024

More updates in #99 #100 and #101

@vmenger vmenger closed this as completed Jun 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vmenger vmenger

Labels
community Regarding community, e.g. docs, guidelines, contact, outreach
Projects
Clinlp development roadmap
Archived in project
Milestone
No milestone
Development

No branches or pull requests
1 participant
@vmenger