facultyai / faculty

A Python library for interacting with the Faculty platform
https://faculty.ai/platform/
18 stars 5 forks source link

list_jobs limit argument needs clarification or more suitable default value #169

Open imrehg opened 4 years ago

imrehg commented 4 years ago

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?)

acroz commented 4 years ago

In general, the Python clients in this library rely on defaults set on the backend rather than providing their own defaults.

We could either:

I'd rather not promise a particular backend-set value as this introduces unnecessary coupling.

What do other similar client libraries do?