diff options
| author | Lorenz Diener <[email protected]> | 2019-05-31 13:42:04 +0200 |
|---|---|---|
| committer | Lorenz Diener <[email protected]> | 2019-05-31 13:42:04 +0200 |
| commit | 55d00cf69efb0a4c9c360f1c28312856c4b1a24e (patch) | |
| tree | fcb4f002d39f86c05f1fe649922b40fba10c9c2d /docs | |
| parent | 27075591b5a4361c41ea32284fb74483c0952f61 (diff) | |
| download | mastodon.py-55d00cf69efb0a4c9c360f1c28312856c4b1a24e.tar.gz | |
Update docs with regards to auth for timelines
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/index.rst b/docs/index.rst index a7bdbca..52bac0f 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
| @@ -54,7 +54,7 @@ node running Mastodon by setting `api_base_url` when creating the | |||
| 54 | api object (or creating an app). | 54 | api object (or creating an app). |
| 55 | 55 | ||
| 56 | Mastodon.py aims to implement the complete public Mastodon API. As | 56 | Mastodon.py aims to implement the complete public Mastodon API. As |
| 57 | of this time, it is feature complete for Mastodon version 2.8.2. Pleromas | 57 | of this time, it is feature complete for Mastodon version 2.8.4. Pleromas |
| 58 | Mastodon API layer, while not an official target, should also be basically | 58 | Mastodon API layer, while not an official target, should also be basically |
| 59 | compatible, and Mastodon.py does make some allowances for behaviour that isn't | 59 | compatible, and Mastodon.py does make some allowances for behaviour that isn't |
| 60 | strictly like Mastodons. | 60 | strictly like Mastodons. |
| @@ -803,7 +803,8 @@ Reading data: Timelines | |||
| 803 | ----------------------- | 803 | ----------------------- |
| 804 | This function allows you to access the timelines a logged in | 804 | This function allows you to access the timelines a logged in |
| 805 | user could see, as well as hashtag timelines and the public (federated) | 805 | user could see, as well as hashtag timelines and the public (federated) |
| 806 | and local timelines. | 806 | and local timelines. For the public, local and hashtag timelines, |
| 807 | access is allowed even when not authenticated. | ||
| 807 | 808 | ||
| 808 | .. _timeline(): | 809 | .. _timeline(): |
| 809 | .. automethod:: Mastodon.timeline | 810 | .. automethod:: Mastodon.timeline |
| @@ -1077,7 +1078,8 @@ This function allows for easy basic decoding of blurhash strings to images. | |||
| 1077 | 1078 | ||
| 1078 | Streaming | 1079 | Streaming |
| 1079 | --------- | 1080 | --------- |
| 1080 | These functions allow access to the streaming API. | 1081 | These functions allow access to the streaming API. For the public, local and hashtag streams, |
| 1082 | access is generally possible without authenticating. | ||
| 1081 | 1083 | ||
| 1082 | If `async` is False, these methods block forever (or until an error is encountered). | 1084 | If `async` is False, these methods block forever (or until an error is encountered). |
| 1083 | 1085 | ||