spla/Mastodonplus.py
1
0
Fork 0
Codi Incidències Sol·licituds Pull repo.project Llançaments Paquets Wiki Activitat

More tiny doc fixing

Explorar la Font
This commit is contained in:
Lorenz Diener 2017-12-14 00:33:22 +01:00
pare 3078a7ac92
commit ae58ae7789
S'han modificat 1 arxius amb 6 adicions i 6 eliminacions
Mostrar estadístiques Descarregar el fitxer de pedaç Descarregar el fitxer de diferències Expand all files Collapse all files

12
docs/index.rst
Veure arxiu

@ -42,11 +42,11 @@ network node. It has an API that allows you to interact with its
every aspect. This is a simple python wrapper for that api, provided every aspect. This is a simple python wrapper for that api, provided
as a single python module. By default, it talks to the as a single python module. By default, it talks to the
`Mastodon flagship instance`_, but it can be set to talk to any `Mastodon flagship instance`_, but it can be set to talk to any
node running Mastodon by setting api_base_url when creating the node running Mastodon by setting `api_base_url` when creating the
api object (or creating an app). api object (or creating an app).
Mastodon.py aims to implement the complete public Mastodon API. As Mastodon.py aims to implement the complete public Mastodon API. As
of this time, it is feature complete for Mastodon version 2.0.0. of this time, it is feature complete for Mastodon version 2.1.0.
A note about rate limits A note about rate limits
------------------------ ------------------------
@ -361,7 +361,7 @@ Card dicts
.. code-block:: python .. code-block:: python
mastodon.status_card(<numerical id>): mastodon.status_card(<numerical id>):
# Returns the folowing dictionary # Returns the following dictionary
{ {
'url': # The URL of the card. 'url': # The URL of the card.
'title': # The title of the card. 'title': # The title of the card.
@ -387,7 +387,7 @@ Search result dicts
.. code-block:: python .. code-block:: python
mastodon.search("<query>") mastodon.search("<query>")
# Returns the folowing dictionary # Returns the following dictionary
{ {
'accounts': # List of account dicts resulting from the query 'accounts': # List of account dicts resulting from the query
'hashtags': # List of hashtag dicts resulting from the query 'hashtags': # List of hashtag dicts resulting from the query
@ -401,7 +401,7 @@ Instance dicts
.. code-block:: python .. code-block:: python
mastodon.instance() mastodon.instance()
# Returns the folowing dictionary # Returns the following dictionary
{ {
'description': # A brief instance description set by the admin 'description': # A brief instance description set by the admin
'email': # The admin contact e-mail 'email': # The admin contact e-mail
@ -419,7 +419,7 @@ Report dicts
.. code-block:: python .. code-block:: python
mastodon.reports()[0] mastodon.reports()[0]
# Returns the folowing dictionary # Returns the following dictionary
{ {
'id': # Numerical id of the report 'id': # Numerical id of the report
'action_taken': # True if a moderator or admin has processed the 'action_taken': # True if a moderator or admin has processed the