Skip to content

Commit

Permalink
mention pyright in contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
jenshnielsen committed Jan 23, 2023
1 parent f72ee45 commit 651d658
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -306,9 +306,9 @@ Our required checks consists of a number of jobs that performs the following act
on Linux and on Windows.

- Run our test suite using pytest as described above.
- Perform type checking of the code in QCoDeS using MyPy. For many of the modules we enforce that the code must be
- Perform type checking of the code in QCoDeS using MyPy and Pyright. For many of the modules we enforce that the code must be
type annotated. We encourage all contributors to type annotate any contribution to QCoDeS. If you need help with this
please feel free to reach out.
please feel free to reach out. Pyright typechecks can be performed inline within VC-code using the Pylance extension.
- Build the documentation using Sphinx with Sphinx warnings as errors. This includes execution of all example notebooks
that are not explicitly marked as not to be executed. Please see here_ for information on how to disable execution of a
notebook.
Expand Down

0 comments on commit 651d658

Please sign in to comment.