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

Documentation revamp #40

Open

4 of 6 tasks

jrdegreeff opened this issue Apr 18, 2022 · 0 comments

Assignees

Labels

Member

jrdegreeff commented Apr 18, 2022 •

edited

Loading

We currently have very little documentation, and what we do have is largely oudated. This issue outlines the items that should be added.

up to date README file
inline documentation on all exported types
inline documentation on all exported functions (i.e. InteratomicPotentials API functions)
instructions in the Documenter docs explaining the type hierarchy and how to interact with existing implementations
Instructions in the Documenter docs explaining how to create a new implementation of each type (empirical, trainable, non-trainable, abstract)
examples of usage

jrdegreeff added the documentation label

jrdegreeff assigned jrdegreeff and dallasfoster

jrdegreeff mentioned this issue

Documentation #41

Merged

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