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 developer's guide to online docs #12

Open
7 tasks
1313e opened this issue Mar 1, 2019 · 0 comments
Open
7 tasks

Add developer's guide to online docs #12

1313e opened this issue Mar 1, 2019 · 0 comments
Assignees
@1313e
Labels
documentation Something is not properly documented

Comments

@1313e
Copy link
Owner

1313e commented Mar 1, 2019 •
edited
Loading

Make a new section in the online docs for developers, where the inner workings and structures of PRISM are explained, including:

  • List of lists data structure;
  • Emulator systems & data points;
  • MPI rank assignments;
  • Writing user/hidden/private methods;
  • User exception handling;
  • Coding style;
  • Documentation style.

This will help current users to understand how PRISM works, and future contributors with how to make extensions.
@1313e 1313e added documentation Something is not properly documented todo This will be worked on in the future labels Mar 1, 2019
@1313e 1313e added this to the v1.1.2 milestone Mar 1, 2019
@1313e 1313e self-assigned this Mar 1, 2019
@1313e 1313e modified the milestones: v1.1.2, v1.1.3 Jun 12, 2019
@1313e 1313e removed this from the v1.1.3 milestone Jun 19, 2019
@1313e 1313e removed the todo This will be worked on in the future label Oct 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@1313e 1313e

Labels
documentation Something is not properly documented
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@1313e