Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unclear what parameters are accepted by various methods #13

Open
jyu00 opened this issue Sep 20, 2024 · 0 comments
Open

Unclear what parameters are accepted by various methods #13

jyu00 opened this issue Sep 20, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@jyu00
Copy link

jyu00 commented Sep 20, 2024

Steps to reproduce the problem

From docs I learned I could do

catalog = QiskitFunctionsCatalog()
catalog.jobs()

So I naturally wanted to see if the jobs() method, for example, accepts any filters. Since there is no API reference, I looked at the source code. But the method is defined as

def jobs(self, **kwargs) -> List[Job]:

which says jobs() accepts some kind of keyword arguments, but it doesn't tell me what they are. The docstring also has no information.

This applies to not just jobs() but many other methods as well.

What is the current behavior?

It is entirely unknown to users what parameters, if any, are accepted by jobs(), list(), etc methods.

What is the expected behavior?

Parameters should be named in the method signature and not just **kwargs, e.g.

def jobs(self, function_title):

At the very least they should be documented in the docstring.

@jyu00 jyu00 added the bug Something isn't working label Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant