Update docs for search function
This commit is contained in:
pare
48d54effc8
commit
d7d8f153a3
S'han modificat 2 arxius amb 13 adicions i 1 eliminacions
|
@ -340,6 +340,18 @@ Card dicts
|
||||||
'provider_url': # URL pointing to the embeds provider
|
'provider_url': # URL pointing to the embeds provider
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Search result dicts
|
||||||
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
mastodon.search(...)
|
||||||
|
# Returns the folowing dictionary
|
||||||
|
{
|
||||||
|
'accounts': # List of account dicts resulting from the query
|
||||||
|
'hashtags': # List of hashtag dicts resulting from the query
|
||||||
|
'statuses': # List of toot dicts resulting from the query
|
||||||
|
}
|
||||||
|
|
||||||
Instance dicts
|
Instance dicts
|
||||||
~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
|
@ -601,7 +601,7 @@ class Mastodon:
|
||||||
Fetch matching hashtags, accounts and statuses. Will search federated
|
Fetch matching hashtags, accounts and statuses. Will search federated
|
||||||
instances if resolve is True.
|
instances if resolve is True.
|
||||||
|
|
||||||
Returns a dict of lists.
|
Returns a search result dict.
|
||||||
"""
|
"""
|
||||||
params = self.__generate_params(locals())
|
params = self.__generate_params(locals())
|
||||||
return self.__api_request('GET', '/api/v1/search', params)
|
return self.__api_request('GET', '/api/v1/search', params)
|
||||||
|
|
Loading…
Referencia en una nova incidència