Skip to content

Commit b7e7806

Browse files
committed
Update tests and docs
1 parent ae30b3c commit b7e7806

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pip install qiskit-ibm-catalog
4242
```python
4343
from qiskit_ibm_catalog import QiskitFunctionsCatalog
4444

45-
catalog = QiskitFunctionsCatalog(token=...)
45+
catalog = QiskitFunctionsCatalog(token=..., instance=...)
4646

4747
catalog.list()
4848
# [<QiskitFunction("ibm/...")>, ...]

docs/tutorials/catalog.ipynb

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
},
1212
{
1313
"cell_type": "code",
14-
"execution_count": 6,
14+
"execution_count": null,
1515
"metadata": {},
1616
"outputs": [
1717
{
@@ -33,7 +33,9 @@
3333
"import os\n",
3434
"from qiskit_ibm_catalog import QiskitFunctionsCatalog\n",
3535
"\n",
36-
"catalog = QiskitFunctionsCatalog(token=os.environ.get(\"TOKEN\"))\n",
36+
"catalog = QiskitFunctionsCatalog(\n",
37+
" token=os.environ.get(\"TOKEN\"), instance=os.environ.get(\"INSTANCE\")\n",
38+
")\n",
3739
"catalog"
3840
]
3941
},

qiskit_ibm_catalog/catalog.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class QiskitFunctionsCatalog:
4848
provider with the API token::
4949
5050
from qiskit_ibm_catalog import QiskitFunctionsCatalog
51-
catalog = QiskitFunctionsCatalog(token=<INSERT_IBM_QUANTUM_TOKEN>)
51+
catalog = QiskitFunctionsCatalog(token=<INSERT_IBM_QUANTUM_TOKEN>, instance=<INSERT_CRN>)
5252
"""
5353

5454
PRE_FILTER_KEYWORD: str = "catalog"

tests/test_wrappers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ class TestCatalog(TestCase):
3535
)
3636
def test_basic_functions(self, _token_mock, jobs_mock, functions_list_mock):
3737
"""Tests basic function of catalog."""
38-
catalog = QiskitFunctionsCatalog("token")
38+
catalog = QiskitFunctionsCatalog(token="token", instance="instance")
3939
jobs = catalog.jobs(limit=10)
4040
functions = catalog.list()
4141

0 commit comments

Comments
 (0)