瀏覽代碼

Fixup doc string

* org.el (org-link-escape): Fixup doc string.
David Maus 14 年之前
父節點
當前提交
41c771378a
共有 1 個文件被更改,包括 4 次插入1 次删除
  1. 4 1
      lisp/org.el

+ 4 - 1
lisp/org.el

@@ -8615,7 +8615,10 @@ This is the list that is used for internal purposes.")
 This is the list that is used before handing over to the browser.")
 
 (defun org-link-escape (text &optional table)
-  "Escape characters in TEXT that are problematic for links."
+  "Return percent escaped representation of TEXT.
+TEXT is a string with the text to escape.
+Optional argument TABLE is a list with characters that should be
+escaped.  When nil, `org-link-escape-chars' is used."
   (if (and org-url-encoding-use-url-hexify (not table))
       (url-hexify-string text)
     (setq table (or table org-link-escape-chars))