[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/xkcd 3c13ae29c4 49/82: Docstrings
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/xkcd 3c13ae29c4 49/82: Docstrings |
Date: |
Mon, 12 Dec 2022 21:59:53 -0500 (EST) |
branch: elpa/xkcd
commit 3c13ae29c41b82ed96e3a95c2f9cf9e1612d43f7
Author: Raphaël Cauderlier <cauderlier@crans.org>
Commit: Raphaël Cauderlier <cauderlier@crans.org>
Docstrings
---
xkcd.el | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/xkcd.el b/xkcd.el
index b7c8eff16c..0092269864 100644
--- a/xkcd.el
+++ b/xkcd.el
@@ -83,6 +83,7 @@ The return value is a string."
(kill-buffer (current-buffer))))))
(defun xkcd-get-image-type (url)
+ "Return a symbol (`png', `jpg' or `gif') corresponding to the last
characters of URL."
(let ((substr (substring url (- (length url) 3))))
(cond
((string= substr "png")
@@ -92,7 +93,7 @@ The return value is a string."
(t 'gif))))
(defun xkcd-download (url num)
- "Download the image linked by URL to NUM. If NUM arleady exists, do nothing"
+ "Download the image linked by URL to NUM. If NUM arleady exists, do
nothing."
;;check if the cache directory exists
(unless (file-exists-p xkcd-cache-dir)
(make-directory xkcd-cache-dir))
@@ -104,8 +105,7 @@ The return value is a string."
name))
(defun xkcd-cache-json (num json-string)
- "Save xkcd NUM's JSON-STRING to cache directory,
-and write xkcd-latest to a file"
+ "Save xkcd NUM's JSON-STRING to cache directory and write xkcd-latest to a
file."
(let ((name (format "%s%d.json" xkcd-cache-dir num)))
(if (> num xkcd-latest)
(with-current-buffer (find-file xkcd-cache-latest)
@@ -121,8 +121,8 @@ and write xkcd-latest to a file"
(kill-buffer (current-buffer))))))
(defun xkcd-insert-image (file num)
- "Insert image FILENAME in buffer with the title-text,
-and animate if FILENAME is a gif"
+ "Insert image described by FILE and NUM in buffer with the title-text.
+If the image is a gif, animate it."
(let ((image (create-image (format "%s%d.%s" xkcd-cache-dir
num
(substring file (- (length file) 3)))
- [nongnu] elpa/xkcd e04bb9535d 44/82: Incorporate some changes from rafoo's branch., (continued)
- [nongnu] elpa/xkcd e04bb9535d 44/82: Incorporate some changes from rafoo's branch., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 57659266fa 65/82: Fix jpg viewing issue., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd a55c3f7dcd 75/82: Add faces to comic title., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 80011da2e7 82/82: Update copyright years., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd ca3eed5603 80/82: Prefer HTTPS to HTTP, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 5c10f6a679 21/82: Merge pull request #4 from purcell/patch-1, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 25594f98c7 31/82: Add info about Melpa in README., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 52c0d270de 36/82: Use one-letter keybindings, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 20e0b48044 42/82: Correct flycheck warnings, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd f5942003bf 45/82: Fix xkcd-get-json, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 3c13ae29c4 49/82: Docstrings,
ELPA Syncer <=
- [nongnu] elpa/xkcd e2daa08012 25/82: Add a better screenshot., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd df47be622f 28/82: The package isn't that hackish now., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd d1bc89dee2 34/82: Add variable xkcd-latest: Stores the latest cached xkcd number., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 7b1a312239 37/82: Add an help-echo text property to display the alt-text, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd e61b7e6ed6 51/82: xkcd-get-json: Get substring between (point) and (point-max), instead of, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 5693718f71 52/82: Add support for browse-url., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 0db98c2ca2 72/82: Add instructions for el-get., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 046ad2c582 67/82: Add README.org, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 7987d64a7e 71/82: * README.md: Remove. Replaced with README.org., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd b637a2aa84 13/82: Update README.md, ELPA Syncer, 2022/12/12