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

Future documentation improvments #176

Open
3 tasks
jpmorgan98 opened this issue Mar 27, 2024 · 1 comment
Open
3 tasks

Future documentation improvments #176

jpmorgan98 opened this issue Mar 27, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@jpmorgan98
Copy link
Collaborator

Adding more documentation to various parts of MC/DC t

  • Doc-strings to all internal functions as well as the user API functions
  • Chapters on the documentation website that work through each one of the examples
  • Theory guide explaining the physics of our methods and algorithms better

This is planned work for the April 2024 hackathon. Future PR's should also include additions to docstrings and documentation when adding functions and features
@jpmorgan98 jpmorgan98 added the documentation Improvements or additions to documentation label Mar 27, 2024
@jpmorgan98
Copy link
Collaborator Author

#174

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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jpmorgan98