Skip to content

Commit 5e5b36f

Browse files
committed
fix: update documentation about job and provider_jobs methods
1 parent ff86cc3 commit 5e5b36f

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

qiskit_ibm_catalog/catalog.py

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,14 @@ def list(self, **kwargs) -> List[QiskitFunction]:
106106
def jobs(self, **kwargs) -> List[Job]:
107107
"""Returns list of jobs.
108108
109+
Args:
110+
limit (int, optional): Maximum number of jobs to return. Defaults to 10.
111+
offset (int, optional): Number of jobs to skip. Defaults to 0.
112+
status (str, optional): Filter by job status.
113+
created_after (str, optional): Filter jobs created after this timestamp.
114+
function_name (str, optional): Filter by function name.
115+
**kwargs: Additional query parameters.
116+
109117
Returns:
110118
List[Job]: jobs
111119
"""
@@ -115,8 +123,12 @@ def provider_jobs(self, function: QiskitFunction, **kwargs) -> List[Job]:
115123
"""List of jobs created in this provider and function.
116124
117125
Args:
118-
function: QiskitFunction
119-
**kwargs: additional parameters for the request
126+
function (QiskitFunction): Function object.
127+
limit (int, optional): Maximum number of jobs to return. Defaults to 10.
128+
offset (int, optional): Number of jobs to skip. Defaults to 0.
129+
status (str, optional): Filter by job status.
130+
created_after (str, optional): Filter jobs created after this timestamp.
131+
**kwargs: Additional query parameters.
120132
121133
Raises:
122134
QiskitServerlessException: validation exception

0 commit comments

Comments
 (0)