From 43c7d7ceb8da17954aedee96bd6fb5444a4a728c Mon Sep 17 00:00:00 2001 From: halcy Date: Tue, 29 Nov 2022 00:50:02 +0200 Subject: Restructure the docs, a lot --- docs/11_misc.rst | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/11_misc.rst (limited to 'docs/11_misc.rst') diff --git a/docs/11_misc.rst b/docs/11_misc.rst new file mode 100644 index 0000000..a85d518 --- /dev/null +++ b/docs/11_misc.rst @@ -0,0 +1,36 @@ +Misc: Markers, reports +====================== +.. py:module:: mastodon +.. py:class: Mastodon + +Markers +------- +These functions allow you to interact with the timeline "last read" markers, +to allow for persisting where the user was reading a timeline between sessions +and clients / devices. + + +Reading +~~~~~~~ +.. automethod:: Mastodon.markers_get + +Writing +~~~~~~~ +.. automethod:: Mastodon.markers_set + +Reports +------- + +Reading +~~~~~~~ +In Mastodon versions before 2.5.0 this function allowed for the retrieval +of reports filed by the logged in user. It has since been removed. + +.. automethod:: Mastodon.reports + +Writing +~~~~~~~ +This function allows you to report a user to the instance moderators as well as to +the users home instance. + +.. automethod:: Mastodon.report \ No newline at end of file -- cgit v1.2.3