From 184240953d62558d8bba5fcb96a0d7ed888632ea Mon Sep 17 00:00:00 2001 From: Lonami Exo Date: Mon, 25 Jun 2018 21:33:44 +0200 Subject: [PATCH] Make more emphasis in the magic sync module --- README.rst | 6 +++--- readthedocs/extra/basic/asyncio-magic.rst | 16 ++++++++++++++++ 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 11198330..7e3fd3cd 100755 --- a/README.rst +++ b/README.rst @@ -8,9 +8,9 @@ Telethon `_ **Python 3** library to interact with Telegram's API. -If you don't like ``asyncio``, you can still use `a simpler version -`_ that uses threads instead. - +**If you're upgrading from Telethon pre-1.0 to 1.0, please make sure to read** +`this section of the documentation +`_. What is this? ------------- diff --git a/readthedocs/extra/basic/asyncio-magic.rst b/readthedocs/extra/basic/asyncio-magic.rst index 69a38bba..48ab9943 100644 --- a/readthedocs/extra/basic/asyncio-magic.rst +++ b/readthedocs/extra/basic/asyncio-magic.rst @@ -4,6 +4,22 @@ Magic with asyncio ================== +.. important:: + + TL; DR; If you've upgraded to Telethon 1.0 from a previous version + **and you're not using events or updates**, add this line: + + .. code-block:: python + + import telethon.sync + + At the beginning of your main script and you will be good. If you + do use updates or events, keep reading, or use `a simpler version + `_ (discouraged). + + You might also want to check the :ref:`changelog`. + + The sync module ***************