From 651d65810aeb4f9fcae14b529fbca00cf975ee60 Mon Sep 17 00:00:00 2001 From: "Jens H. Nielsen" Date: Mon, 23 Jan 2023 10:16:54 +0100 Subject: [PATCH] mention pyright in contributing --- CONTRIBUTING.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 90cd072f1ad..d3bc3d38844 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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.