diff options
author | marty hiatt <martianhiatus@riseup.net> | 2024-03-27 14:52:14 +0100 |
---|---|---|
committer | marty hiatt <martianhiatus@riseup.net> | 2024-03-27 14:52:14 +0100 |
commit | 1454c2253d507adf9be1d413172e0b11b853c661 (patch) | |
tree | 6c1e17c1483d41e555160c4acb8505ec7b5d4ecb /lisp | |
parent | 7df610ba70be4349db418c901af33fdf126997bb (diff) |
docstrings - reduce explicit refs to Mastodon itself.
Diffstat (limited to 'lisp')
-rw-r--r-- | lisp/mastodon-profile.el | 4 | ||||
-rw-r--r-- | lisp/mastodon-tl.el | 2 | ||||
-rw-r--r-- | lisp/mastodon-toot.el | 6 | ||||
-rw-r--r-- | lisp/mastodon.el | 12 |
4 files changed, 12 insertions, 12 deletions
diff --git a/lisp/mastodon-profile.el b/lisp/mastodon-profile.el index 55041c9..7b5a700 100644 --- a/lisp/mastodon-profile.el +++ b/lisp/mastodon-profile.el @@ -131,7 +131,7 @@ is updated on entering mastodon mode and on toggle any setting it contains") (define-minor-mode mastodon-profile-update-mode - "Minor mode to update Mastodon user profile." + "Minor mode to update user profile." :group 'mastodon-profile :keymap mastodon-profile-update-mode-map :global nil) @@ -790,7 +790,7 @@ If the handle does not match a search return then retun NIL." (elt matching-account 0)))) (defun mastodon-profile--account-from-id (user-id) - "Request an account object relating to a USER-ID from Mastodon." + "Request an account object relating to a USER-ID." (mastodon-http--get-json (mastodon-http--api (format "accounts/%s" user-id)))) diff --git a/lisp/mastodon-tl.el b/lisp/mastodon-tl.el index a35ae5e..4c0375d 100644 --- a/lisp/mastodon-tl.el +++ b/lisp/mastodon-tl.el @@ -216,7 +216,7 @@ respects the user's `browse-url' settings." ;;; VARIABLES (defvar-local mastodon-tl--buffer-spec nil - "A unique identifier and functions for each Mastodon buffer.") + "A unique identifier and functions for each mastodon buffer.") (defvar-local mastodon-tl--update-point nil "When updating a mastodon buffer this is where new toots will be inserted. diff --git a/lisp/mastodon-toot.el b/lisp/mastodon-toot.el index 062eaf0..a48d5d9 100644 --- a/lisp/mastodon-toot.el +++ b/lisp/mastodon-toot.el @@ -699,7 +699,7 @@ CANCEL means the toot was not sent, so we save the toot text as a draft." (mastodon-toot--restore-previous-window-config prev-window-config))) (defun mastodon-toot--cancel () - "Kill new-toot buffer/window. Does not POST content to Mastodon. + "Kill new-toot buffer/window. Does not POST content. If toot is not empty, prompt to save text as a draft." (interactive) (if (mastodon-toot--empty-p) @@ -840,7 +840,7 @@ to `emojify-user-emojis', and the emoji data is updated." ;;; SEND TOOT FUNCTION (defun mastodon-toot--send () - "POST contents of new-toot buffer to Mastodon instance and kill buffer. + "POST contents of new-toot buffer to fediverse instance and kill buffer. If media items have been attached and uploaded with `mastodon-toot--attach-media', they are attached to the toot. If `mastodon-toot--edit-item-id' is non-nil, PUT contents to @@ -1953,7 +1953,7 @@ Only text that is not one of these faces will be spell-checked." (define-minor-mode mastodon-toot-mode - "Minor mode to capture Mastodon toots." + "Minor mode for composing toots." :keymap mastodon-toot-mode-map :global nil) diff --git a/lisp/mastodon.el b/lisp/mastodon.el index 4667450..70ab73c 100644 --- a/lisp/mastodon.el +++ b/lisp/mastodon.el @@ -110,8 +110,8 @@ :group 'external) (defcustom mastodon-instance-url "https://mastodon.social" - "Base URL for the Mastodon instance you want to be active. -For example, if your mastodon username is + "Base URL for the fediverse instance you want to be active. +For example, if your 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\". @@ -125,7 +125,7 @@ changes to take effect." (defcustom mastodon-active-user nil "Username of the active user. -For example, if your mastodon username is +For example, if your username is \"example_user@social.instance.org\", and you want this account to be active, the value of this variable should be \"example_user\". @@ -275,7 +275,7 @@ See `mastodon-toot-display-orig-in-reply-buffer'.") ;;;###autoload (defun mastodon () - "Connect Mastodon client to `mastodon-instance-url' instance." + "Connect client to `mastodon-instance-url' instance." (interactive) (let* ((tls (list "home" "local" @@ -295,7 +295,7 @@ See `mastodon-toot-display-orig-in-reply-buffer'.") (if buffer (pop-to-buffer buffer '(display-buffer-same-window)) (mastodon-tl--get-home-timeline) - (message "Loading Mastodon account %s on %s..." + (message "Loading fediverse account %s on %s..." (mastodon-auth--user-acct) mastodon-instance-url)))) @@ -477,7 +477,7 @@ Calls `mastodon-tl--get-buffer-type', which see." (add-hook 'mastodon-mode-hook #'mastodon-mode-hook-fun) (define-derived-mode mastodon-mode special-mode "Mastodon" - "Major mode for Mastodon, the federated microblogging network." + "Major mode for fediverse services using the Mastodon API." (read-only-mode 1)) (provide 'mastodon) |