facultyai / facultyai/faculty

list_jobs limit argument needs clarification or more suitable default value

Open
#169 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
16
Forks
5
PR merge metrics
No merged PRs in 30d

Description

In `JobClient`, the `list_jobs` function has a `limit` argument, which sets the number of jobs returned in a single request. The default value is is `None` in the library, which means "use the default limit from the backend service". That default value is (I believe) `10`.

https://github.com/facultyai/faculty/blob/master/faculty/clients/job.py#L314

Had a request to use that upstream default value in the library to make the effect of different values clearer. Otherwise interpreting the behaviour of `None` is difficult (for example will there be paging in that case or all records are returned?)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.