aboutsummaryrefslogtreecommitdiff
path: root/lisp/mastodon.el
diff options
context:
space:
mode:
authorAbhiseck Paira <abhiseckpaira@disroot.org>2022-01-13 16:22:10 +0530
committerAbhiseck Paira <abhiseckpaira@disroot.org>2022-01-13 16:22:10 +0530
commit2349750b607388a1a665c5e68b5708d9563ecaff (patch)
tree640d54495380c1788f354c36900b62bb1df318cf /lisp/mastodon.el
parent20db4e11f54e324af9e7e6c8f96a75589445629b (diff)
mastodon.el: update `mastodon-instance-url' docstring
Update the docstring for the defcustom `mastodon-instance-url' to clarify what it's value should be to reflect the changes introduced in the previous commit.
Diffstat (limited to 'lisp/mastodon.el')
-rw-r--r--lisp/mastodon.el16
1 files changed, 15 insertions, 1 deletions
diff --git a/lisp/mastodon.el b/lisp/mastodon.el
index c7fcccf..2758f9d 100644
--- a/lisp/mastodon.el
+++ b/lisp/mastodon.el
@@ -94,7 +94,21 @@
:group 'external)
(defcustom mastodon-instance-url "https://mastodon.social"
- "Base URL for the Masto instance from which you toot."
+ "Base URL for the Mastodon instance you want to be active.
+
+For example, if your mastodon username is
+\"example_user@social.instance.org\", and you want this account
+to be active, the value of this variable should be
+\"https://social.instance.org\".
+
+Also for completeness, the value of `mastodon-active-user' should
+be \"example_user\".
+
+After setting these variables you should restart Emacs for these
+changes to take effect."
+ :group 'mastodon
+ :type 'string)
+
(defcustom mastodon-active-user "user"
"Username of the active user.