org-export-link--remote-local-copy: Update docstring

* lisp/ox.el (org-export-link-localise): Make sure that docstring is
narrower than 80 chars.  Clarify the return value when LINK is not a
remote link.
This commit is contained in:
Ihor Radchenko 2022-02-14 12:42:57 +08:00
parent 0cb0760206
commit bc8c3e7795
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 3 additions and 1 deletions

View File

@ -4476,7 +4476,9 @@ Return value can be an object or an element:
:write-immediately t))))
(defun org-export-link-localise (link)
"If LINK refers to a remote resource, modify it to point to a local downloaded copy."
"Convert remote LINK to local link.
If LINK refers to a remote resource, modify it to point to a local
downloaded copy. Otherwise, return unchanged LINK."
(when (org-export-link-remote-p link)
(let* ((local-path (org-export-link--remote-local-copy link)))
(setcdr link