code/twython
1
0
Fork 0
Code Issues 23 Pull requests 4 Projects Releases 5 Packages Wiki Activity Actions

special_functions.rst: typo: excepts → accepts

Browse source
This commit is contained in:
Will Thompson 2015-06-17 16:27:31 +01:00
parent 2f0508bcdf
commit 4e6963d8cc
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/usage/special_functions.rst
View file

@ -85,7 +85,7 @@ will be replaced with:
- For user mentions that are replaced we add ``class="twython-mention"`` to the anchor tag - For user mentions that are replaced we add ``class="twython-mention"`` to the anchor tag
- For hashtags that are replaced we add ``class="twython-hashtag"`` to the anchor tag - For hashtags that are replaced we add ``class="twython-hashtag"`` to the anchor tag
This function excepts two parameters: ``use_display_url`` and ``use_expanded_url`` This function accepts two parameters: ``use_display_url`` and ``use_expanded_url``
By default, ``use_display_url`` is ``True``. Meaning the link displayed in the tweet text will appear as (ex. google.com, github.com) By default, ``use_display_url`` is ``True``. Meaning the link displayed in the tweet text will appear as (ex. google.com, github.com)
If ``use_expanded_url`` is ``True``, it overrides ``use_display_url``. The urls will then be displayed as (ex. http://google.com, https://github.com) If ``use_expanded_url`` is ``True``, it overrides ``use_display_url``. The urls will then be displayed as (ex. http://google.com, https://github.com)
If ``use_display_url`` and ``use_expanded_url`` are ``False``, short url will be used (t.co/xxxxx) If ``use_display_url`` and ``use_expanded_url`` are ``False``, short url will be used (t.co/xxxxx)