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.

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

Updating the documentation #28

Open
4 tasks
phajy opened this issue Apr 6, 2023 · 0 comments
Open
4 tasks

Updating the documentation #28

phajy opened this issue Apr 6, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@phajy
Copy link
Collaborator

phajy commented Apr 6, 2023

Once the code has been tidied up we'll need to update the documentation. This is currently not compiling but the code tidy will fix that. Some things I think we need to do for the documentation:

  • Update the README with a simple example of how to load the module and do a simple fit.
  • Ensure there is in-line documentation for the relevant exported functions.
  • Have more extensive documentation on how the model can be set up and fit.
  • Make sure the documentation compiles automatically.
@phajy phajy added the documentation Improvements or additions to documentation label Apr 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

2 participants