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

list_jobs entrypoint redirects to internal function for paged function #123

Open
sanderegg opened this issue Nov 17, 2023 · 0 comments
Open
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@sanderegg
Copy link
Member

What version of osparc are you using?

0.6.3

Long story short

pip install osparc
then doing

with osparc.ApiClient(cfg) as api_client:
    solvers_api = osparc.SolversApi(api_client)
    solvers_api.list_jobs(...)

the doc string of list_jobs tells me to look at get_jobs_page for the paginated version. then looking at get_jobs_page tells me it is internal.
The proper paginated method is called jobs

Expected behaviour

the docstring should bring me to the correct paginated method.

Actual behaviour

docstring is wrong

Steps to reproduce

Your environment

@sanderegg sanderegg added the bug Something isn't working label Nov 17, 2023
@pcrespov pcrespov added this to the Tom Bombadil milestone Jul 12, 2024
@pcrespov pcrespov added the documentation Improvements or additions to documentation label Jul 12, 2024
@mrnicegyu11 mrnicegyu11 removed this from the Tom Bombadil milestone Sep 11, 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 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants