You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -135,9 +135,9 @@ If you'd like to use an editable install with an optimized binary you can
135
135
run `python setup.py build_rust --release --inplace` after you install in
136
136
editable mode to recompile the rust extensions in release mode.
137
137
138
-
Note that in order to run `python setup.py ...` commands you need have build
139
-
dependency packages installed in your environment, which are listed in the
140
-
`pyproject.toml` file under the `[build-system]` section.
138
+
Note that in order to run `python setup.py ...` commands you need to have the
139
+
build dependency packages, which are listed in the`pyproject.toml` file under
140
+
the `[build-system]` section, installed in your environment.
141
141
142
142
### Compile time options
143
143
@@ -538,7 +538,7 @@ you will need to check that your changes don't break any snapshot tests, and add
538
538
new tests where necessary. You can do this as follows:
539
539
540
540
1. Make sure you have pushed your latest changes to your remote branch.
541
-
2. Go to link: `https://mybinder.org/v2/gh/<github_user>/<repo>/<branch>?urlpath=apps/test/ipynb/mpl_tester.ipynb`. For example, if your GitHub username is `username`, your forked repo has the same name the original, and your branch is `my_awesome_new_feature`, you should visit https://mybinder.org/v2/gh/username/qiskit/my_awesome_new_feature?urlpath=apps/test/ipynb/mpl_tester.ipynb.
541
+
2. Go to link: `https://mybinder.org/v2/gh/<github_user>/<repo>/<branch>?urlpath=apps/test/ipynb/mpl_tester.ipynb`. For example, if your GitHub username is `username`, your forked repo has the same name as the original, and your branch is `my_awesome_new_feature`, you should visit https://mybinder.org/v2/gh/username/qiskit/my_awesome_new_feature?urlpath=apps/test/ipynb/mpl_tester.ipynb.
542
542
This opens a Jupyter Notebook application running in the cloud that automatically runs
543
543
the snapshot tests (note this may take some time to finish loading).
544
544
3. Each test result provides a set of 3 images (left: reference image, middle: your test result, right: differences). In the list of tests the passed tests are collapsed and failed tests are expanded. If a test fails, you will see a situation like this:
@@ -766,12 +766,12 @@ code formatting. You can simply run `cargo fmt` (if you installed Rust with the
766
766
default settings using `rustup`), and it will update the code formatting automatically to
767
767
conform to the style guidelines. This is very similar to running `tox -eblack` for Python code. For lint checking, Qiskit uses [clippy](https://github.com/rust-lang/rust-clippy) which can be invoked via `cargo clippy`.
768
768
769
-
Rust lint and formatting checks are included in the the `tox -elint` command. For CI to pass you will need both checks to pass without any warnings or errors. Note that this command checks the code but won't apply any modifications, if you need to update formatting, you'll need to run `cargo fmt`.
769
+
Rust lint and formatting checks are included in the `tox -elint` command. For CI to pass you will need both checks to pass without any warnings or errors. Note that this command checks the code but won't apply any modifications, if you need to update formatting, you'll need to run `cargo fmt`.
770
770
771
771
### C style and lint
772
772
773
773
Qiskit uses [clang-format](https://clang.llvm.org/docs/ClangFormat.html) to format C code.
774
-
The style is based on LLVM, with some few Qiskit-specific adjustments.
774
+
The style is based on LLVM, with a few Qiskit-specific adjustments.
775
775
To check whether the C code conforms to the style guide, you can run `make cformat`. This check
776
776
will need to execute without any warnings or errors for CI to pass.
777
777
Automatic formatting can be applied by `make fix_cformat`.
0 commit comments