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

Add documentation after code refactoring and new library mode #468

Open
8 tasks
giovannipizzi opened this issue Feb 15, 2024 · 0 comments
Open
8 tasks

Add documentation after code refactoring and new library mode #468

giovannipizzi opened this issue Feb 15, 2024 · 0 comments
Assignees
Milestone

Comments

@giovannipizzi
Copy link
Member

As mentioned in #466, we should add documentation (possibly for different categories of users: users, developers ...) of all the changes happened in #466 and how one can adapt existing code (e.g. for open PRs) or develop new code.

  • Documentations for users of the library
  • Examples of use of the library in Fortran (and docs on how to use them)
  • Examples of use of the library in C (and docs on how to use them)
  • Examples of use of the library in Python (and docs on how to use them)
  • Examples of use of the library in Julia (possibly adapted from the Python ones with the help of @qiaojunfeng)
  • Improve documentation in the library interface source code
  • Documentation for new developers (on the wiki)
  • Short section on how to migrate from previous code to new code for those who have un-merged changes (on the wiki)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants