From e2e6d7182ec6b03400521ba6914cfda53035c589 Mon Sep 17 00:00:00 2001 From: Rapptz Date: Mon, 20 Jun 2016 00:59:30 -0400 Subject: [PATCH] Add FAQ entry for `after` being called right away. --- docs/faq.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/faq.rst b/docs/faq.rst index 94d75b48d..60684b0f8 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -163,6 +163,27 @@ this together we can do the following: :: player = await voice.create_ytdl_player(url, after=my_after) player.start() +Why is my "after" function being called right away? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The ``after`` keyword argument expects a *function object* to be passed in. Similar to how ``threading.Thread`` expects a +callable in its ``target`` keyword argument. This means that the following are invalid: + +.. code-block:: python + + player = await voice.create_ytdl_player(url, after=self.foo()) + other = await voice.create_ytdl_player(url, after=self.bar(10)) + +However the following are correct: + +.. code-block:: python + + player = await voice.create_ytdl_player(url, after=self.foo) + other = await voice.create_ytdl_player(url, after=lambda: self.bar(10)) + +Basically, these functions should not be called. + + How do I run something in the background? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~