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

Document download call blocking and non-blocking calls #120

Open
dreamflasher opened this issue Jan 10, 2023 · 1 comment
Open

Document download call blocking and non-blocking calls #120

dreamflasher opened this issue Jan 10, 2023 · 1 comment
Labels
documentation An improvement to the documentation good first issue help wanted

Comments

@dreamflasher
Copy link
Contributor

From the documentation it's not clear what the current behaviour of dl.download() is. But either way it would be great if you would add an option to toggle the behaviour: blocking or non-blocking.

@dreamflasher
Copy link
Contributor Author

Apparently this does exist, but is undocumented:

blocking:

def download(self):
Downloader.download()

non-blocking:

async def run_download(self):
Downloader.run_download()

I suggest do add this to the documentation.

@dreamflasher dreamflasher changed the title Make download call blocking or non-blocking Document download call blocking and non-blocking calls Jan 11, 2023
@Cadair Cadair added help wanted good first issue documentation An improvement to the documentation labels Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation An improvement to the documentation good first issue help wanted
Projects
None yet
Development

No branches or pull requests

2 participants