@@ -22,7 +22,7 @@ Qiskit Experiments are documented below.
22
22
* [ Linking to issues] ( #linking-to-issues )
23
23
- [ Generating release notes] ( #generating-release-notes )
24
24
+ [ Documentation] ( #documentation )
25
- + [ Experiment class documentation] ( #experiment-class-documenation )
25
+ + [ Experiment class documentation] ( #experiment-class-documentation )
26
26
+ [ Analysis class documentation] ( #analysis-class-documentation )
27
27
+ [ Populating the table of contents] ( #populating-the-table-of-contents )
28
28
+ [ Updating the tutorials] ( #updating-the-tutorials )
@@ -106,34 +106,33 @@ an isolated virtualenv for running tests. This means it does not pollute your sy
106
106
python when running. Additionally, the environment that tox sets up matches the CI
107
107
environment more closely and it runs the tests in parallel (resulting in much faster
108
108
execution). To run tests on all installed supported python versions and lint/style
109
- checks you can simply run ` tox ` . Or if you just want to run the tests once run for a
110
- specific python version: ` tox -epy37 ` (or replace py37 with the python version you want
111
- to use, py35 or py36).
109
+ checks you can simply run ` tox ` . Or if you just want to run the tests once for a
110
+ specific python version such as 3.10: ` tox -epy310 ` .
112
111
113
112
If you just want to run a subset of tests you can pass a selection regex to the test
114
113
runner. For example, if you want to run all tests that have "dag" in the test id you can
115
- run: ` tox -epy37 - - dag ` . You can pass arguments directly to the test runner after the
114
+ run: ` tox -- dag ` . You can pass arguments directly to the test runner after the
116
115
bare ` -- ` . To see all the options on test selection you can refer to the stestr manual:
117
116
https://stestr.readthedocs.io/en/stable/MANUAL.html#test-selection
118
117
119
118
If you want to run a single test module, test class, or individual test method you can
120
119
do this faster with the ` -n ` /` --no-discover ` option. For example, to run a module:
121
120
```
122
- tox -epy37 - - -n test.python.test_examples
121
+ tox -- -n test.python.test_examples
123
122
```
124
123
Or to run the same module by path:
125
124
126
125
```
127
- tox -epy37 - - -n test/python/test_examples.py
126
+ tox -- -n test/python/test_examples.py
128
127
```
129
128
To run a class:
130
129
131
130
```
132
- tox -epy37 - - -n test.python.test_examples.TestPythonExamples
131
+ tox -- -n test.python.test_examples.TestPythonExamples
133
132
```
134
133
To run a method:
135
134
```
136
- tox -epy37 - - -n test.python.test_examples.TestPythonExamples.test_all_examples
135
+ tox -- -n test.python.test_examples.TestPythonExamples.test_all_examples
137
136
```
138
137
139
138
#### STDOUT/STDERR and logging capture
@@ -312,7 +311,7 @@ formatted in the same manner throughout our experiment library. You can use stan
312
311
[ reStructuredText] ( https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html )
313
312
directives along with our syntax.
314
313
315
- #### Experiment class documenation
314
+ #### Experiment class documentation
316
315
317
316
You should complete or update the class documentation and method documentation for
318
317
` _default_experiment_options ` . You can use several predefined sections for the class docstring.
@@ -432,7 +431,7 @@ You can use the same syntax and section headers for the analysis class documenta
432
431
variable names shown in analysis results. You can write symbol :math:`a` here too.
433
432
434
433
# section: fit_parameters
435
- Optional. Description for fit parametres in the model.
434
+ Optional. Description for fit parameters in the model.
436
435
You can also write how initial guess is generated and how fit bound is determined.
437
436
438
437
defpar a:
@@ -559,7 +558,7 @@ to the user, use the `:hide-code:` and `:hide-output:` directives:
559
558
:hide-output:
560
559
561
560
from qiskit.test.ibmq_mock import mock_get_backend
562
- backend = mock_get_backend('FakeArmonk ')
561
+ backend = mock_get_backend('FakeLima ')
563
562
564
563
To ignore an error from a Jupyter cell block, use the ` :raises: ` directive.
565
564
#### Building documentation locally
0 commit comments