diff --git a/docs/generate.py b/docs/generate.py
index ae2bd43c..75ab3091 100755
--- a/docs/generate.py
+++ b/docs/generate.py
@@ -207,6 +207,13 @@ def get_description(arg):
desc.append('This argument can be omitted.')
otherwise = True
+ if arg.type in {'InputPeer', 'InputUser', 'InputChannel'}:
+ desc.append(
+ 'Anything entity-like will work if the library can find its '
+ 'Input
version (e.g., usernames, Peer
, '
+ 'User
or Channel
objects, etc.).'
+ )
+
if arg.is_vector:
if arg.is_generic:
desc.append('A list of other Requests must be supplied.')
@@ -221,7 +228,11 @@ def get_description(arg):
desc.insert(1, 'Otherwise,')
desc[-1] = desc[-1][:1].lower() + desc[-1][1:]
- return ' '.join(desc)
+ return ' '.join(desc).replace(
+ 'list',
+ 'list'
+ )
def copy_replace(src, dst, replacements):
diff --git a/docs/res/css/docs.css b/docs/res/css/docs.css
index 05c61c9f..cd67af70 100644
--- a/docs/res/css/docs.css
+++ b/docs/res/css/docs.css
@@ -108,6 +108,10 @@ span.sh4 {
color: #06c;
}
+span.tooltip {
+ border-bottom: 1px dashed #444;
+}
+
#searchBox {
width: 100%;
border: none;
diff --git a/readthedocs/extra/basic/creating-a-client.rst b/readthedocs/extra/basic/creating-a-client.rst
index bf565bb0..e68f170b 100644
--- a/readthedocs/extra/basic/creating-a-client.rst
+++ b/readthedocs/extra/basic/creating-a-client.rst
@@ -95,6 +95,11 @@ is just a matter of taste, and how much control you need.
Remember that you can get yourself at any time with ``client.get_me()``.
+.. warning::
+ Please note that if you fail to login around 5 times (or change the first
+ parameter of the ``TelegramClient``, which is the session name) you will
+ receive a ``FloodWaitError`` of around 22 hours, so be careful not to mess
+ this up! This shouldn't happen if you're doing things as explained, though.
.. note::
If you want to use a **proxy**, you have to `install PySocks`__