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

Improve the Tutorial for using relax.methods #17

Closed
BirkhoffG opened this issue Oct 29, 2023 · 0 comments · Fixed by #19
Closed

Improve the Tutorial for using relax.methods #17

BirkhoffG opened this issue Oct 29, 2023 · 0 comments · Fixed by #19
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@BirkhoffG
Copy link
Owner

We have an incomplete tutorial on using relax.methods. Let's start to improve this tutorial.

Delivery

  1. git checkout tutorial
  2. Go to tutorials/methods.ipynb
  3. Run a grammar check on the entire notebook to correct any spelling/grammar mistakes.
  4. Finish all four TODOs.
  5. Create a pull request to commit your changes. Please also read this before creating a pull request.

Rules-of-Thumb in Writing Tutorials

The tutorial should be accessible to developers. Use as many examples as possible so that the developers can just copy/paste your code for their usage.

@BirkhoffG BirkhoffG added the documentation Improvements or additions to documentation label Oct 29, 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
None yet
Development

Successfully merging a pull request may close this issue.

2 participants