aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLorenz Diener <[email protected]>2019-04-28 13:58:18 +0200
committerLorenz Diener <[email protected]>2019-04-28 13:58:18 +0200
commitac7196c443db8453ccb6c3c2407c9e844ea4cbae (patch)
treea8e3b7f1f3e8c42ebbca7b4d2362e0e53b5d7670 /docs
parent06df1c281eb0825ec9f646960f4d9426eba7e081 (diff)
downloadmastodon.py-ac7196c443db8453ccb6c3c2407c9e844ea4cbae.tar.gz
Add conversation read marking + tests/docs
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst16
1 files changed, 11 insertions, 5 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 9bbd6f7..48fb0c1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,7 +3,7 @@ Mastodon.py
3.. py:module:: mastodon 3.. py:module:: mastodon
4.. py:class: Mastodon 4.. py:class: Mastodon
5 5
6Register your app! This only needs to be done once. Uncomment the code and substitute in your information. 6Register your app! This only needs to be done once. Uncomment the code and substitute in your information:
7 7
8.. code-block:: python 8.. code-block:: python
9 9
@@ -17,7 +17,7 @@ Register your app! This only needs to be done once. Uncomment the code and subst
17 ) 17 )
18 ''' 18 '''
19 19
20Then login. This can be done every time, or use persisted. 20Then login. This can be done every time, or you can use the persisted information:
21 21
22.. code-block:: python 22.. code-block:: python
23 23
@@ -33,7 +33,7 @@ Then login. This can be done every time, or use persisted.
33 to_file = 'pytooter_usercred.secret' 33 to_file = 'pytooter_usercred.secret'
34 ) 34 )
35 35
36To post, create an actual API instance. 36To post, create an actual API instance:
37 37
38.. code-block:: python 38.. code-block:: python
39 39
@@ -790,7 +790,7 @@ These functions allow you to view information about lists.
790Reading data: Follows 790Reading data: Follows
791--------------------- 791---------------------
792 792
793.. automethod:: Mastodon.follows 793.. automethod:: Mastodon.followshttps://docs.joinmastodon.org/api/rest
794 794
795Reading data: Favourites 795Reading data: Favourites
796------------------------ 796------------------------
@@ -868,6 +868,12 @@ These functions allow you to clear all or some notifications.
868.. automethod:: Mastodon.notifications_clear 868.. automethod:: Mastodon.notifications_clear
869.. automethod:: Mastodon.notifications_dismiss 869.. automethod:: Mastodon.notifications_dismiss
870 870
871Writing data: Conversations
872---------------------------
873This function allows you to mark conversations read.
874
875.. automethod:: Mastodon.conversations_read
876
871Writing data: Accounts 877Writing data: Accounts
872---------------------- 878----------------------
873These functions allow you to interact with other accounts: To (un)follow and 879These functions allow you to interact with other accounts: To (un)follow and
@@ -1023,4 +1029,4 @@ about who helped with which particular feature or fix in the changelog.
1023 1029
1024.. _Mastodon: https://github.com/tootsuite/mastodon 1030.. _Mastodon: https://github.com/tootsuite/mastodon
1025.. _Mastodon flagship instance: http://mastodon.social/ 1031.. _Mastodon flagship instance: http://mastodon.social/
1026.. _Mastodon api docs: https://github.com/tootsuite/documentation/ 1032.. _Official Mastodon api docs: https://docs.joinmastodon.org/api/rest
Powered by cgit v1.2.3 (git 2.41.0)