From 47eaa7a194fa38bc39c45fbd5e3f86a01d78755f Mon Sep 17 00:00:00 2001 From: marty hiatt Date: Fri, 30 Dec 2022 10:23:43 +1100 Subject: docstrings --- lisp/mastodon-tl.el | 5 +++-- lisp/mastodon-toot.el | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lisp/mastodon-tl.el b/lisp/mastodon-tl.el index 0a30186..9206695 100644 --- a/lisp/mastodon-tl.el +++ b/lisp/mastodon-tl.el @@ -1430,7 +1430,8 @@ PARAMS is used to send 'local=true' for local timeline." ;; TODO ;; Look into the JSON returned here by Local (defun mastodon-tl--updated-json (endpoint id &optional params) - "Return JSON for timeline ENDPOINT since ID." + "Return JSON for timeline ENDPOINT since ID. +PARAMS are any parameters to send with the request." (let* ((args `(("since_id" . ,(mastodon-tl--as-string id)))) (args (if params (push params args) args)) (url (mastodon-http--api endpoint))) @@ -2579,7 +2580,7 @@ For use after e.g. deleting a toot." (concat url-base "&" param))) (defun mastodon-tl--use-link-header-p () - "Return t if we are in a view that uses Link header pagination. + "Return t if we are in a view needing Link header pagination. Currently this includes favourites, bookmarks, and profile pages when showing followers or accounts followed." (let ((buf (buffer-name (current-buffer))) diff --git a/lisp/mastodon-toot.el b/lisp/mastodon-toot.el index c18f751..3406ec4 100644 --- a/lisp/mastodon-toot.el +++ b/lisp/mastodon-toot.el @@ -844,8 +844,8 @@ Buffer-local variable `mastodon-toot-previous-window-config' holds the config." (goto-char (cadr config))) (defun mastodon-toot--mentions-to-string (mentions) - "Applies mastodon-toot--process-local function to each mention, -removes empty string (self) from result and joins the sequence with whitespace \" \"." + "Apply `mastodon-toot--process-local' function to each mention in MENTIONS. +Remove empty string (self) from result and joins the sequence with whitespace." (mapconcat (lambda(mention) mention) (remove "" (mapcar (lambda(x) (mastodon-toot--process-local x)) mentions)) -- cgit v1.2.3