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.

Sign up for GitHub

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

Jump to bottom

Docs: Missing information in API doc #1462

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

Docs: Missing information in API doc #1462

jyu00 opened this issue Aug 20, 2024 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@jyu00
Copy link

jyu00 commented Aug 20, 2024 •
edited
Loading

Several of the API references are missing information.

One example is the QiskitFunction, which doesn't have description for all parameters, such as tags:

image

Another example is the get_jobs() and list() methods that don't tell users what **kwargs are actually accepted:

image

cc @jenglick
@jyu00 jyu00 added the bug Something isn't working label Aug 20, 2024
@jyu00 jyu00 changed the title Docs: Missing parameters in API doc Docs: Missing information in API doc Aug 20, 2024
@Tansito Tansito added the documentation Improvements or additions to documentation label Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Tansito @jyu00