Skip to content
New issue

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

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

Already on GitHub? # to your account

Review and improve documentation of arguments #38

Closed
Cadair opened this issue Mar 7, 2020 · 0 comments · Fixed by #92
Closed

Review and improve documentation of arguments #38

Cadair opened this issue Mar 7, 2020 · 0 comments · Fixed by #92
Labels
documentation An improvement to the documentation good first issue help wanted

Comments

@Cadair
Copy link
Owner

Cadair commented Mar 7, 2020

Currently there is two main parts of the API, the constructor to Download and the enqueue_file method, both of these accept many more kwargs that are in the function signature or docstring due to them getting passed down the tree into the partial functions that get executed in the loop etc. We should make sure that we are using clear keyword argument names and that it's possible to easily see all the possible arguments in the docs (and even better in function introspection).

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation An improvement to the documentation good first issue help wanted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant