From 6d4ec618f2f02a20874973647f34cbca9e9936cc Mon Sep 17 00:00:00 2001 From: halcy Date: Mon, 21 Nov 2022 20:21:12 +0200 Subject: [PATCH] small docs change --- TODO.md | 3 ++- docs/index.rst | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/TODO.md b/TODO.md index 7be1c70..cf845fc 100644 --- a/TODO.md +++ b/TODO.md @@ -37,7 +37,7 @@ Refer to mastodon changelog and API docs for details when implementing, add or m 3.4.2 ----- -* [ ] Add configuration attribute to GET /api/v1/instance +* [postpone to later] Add configuration attribute to GET /api/v1/instance 3.5.0 ----- @@ -66,3 +66,4 @@ General improvements that would be good to do before doing another release: * [x] Fix the CI * [ ] Get test coverage like, real high * [ ] Add all those streaming events?? +* [ ] Document return values diff --git a/docs/index.rst b/docs/index.rst index 8b47fad..450300e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -671,6 +671,7 @@ Instance dicts mastodon.instance() # Returns the following dictionary { + 'domain': # The instances domain name 'description': # A brief instance description set by the admin 'short_description': # An even briefer instance description 'email': # The admin contact email