ox-texinfo: Fix docstrings

* lisp/ox-texinfo.el (org-texinfo--sanitize-menu,
  org-texinfo--sanitize-content): Fix docstrings.
This commit is contained in:
Nicolas Goaziou 2014-08-10 22:55:20 +02:00
parent 3ee7895c03
commit 2ef63acae2
1 changed files with 5 additions and 8 deletions

View File

@ -519,19 +519,16 @@ retrieved."
;;;; Menu sanitizing
(defun org-texinfo--sanitize-menu (title)
"Remove invalid characters from TITLE for use in menus and
nodes.
Based on Texinfo specifications, the following must be removed:
@ { } ( ) : . ,"
"Remove invalid characters for use in menus and nodes.
TITLE is the menu entry to sanitize, as a string. The following
must be removed: @ { } ( ) : . ,"
(replace-regexp-in-string "[@{}():,.]" "" title))
;;;; Content sanitizing
(defun org-texinfo--sanitize-content (text)
"Ensure characters are properly escaped when used in headlines or blocks.
Escape characters are: @ { }"
"Escape special characters in string TEXT.
Special characters are: @ { }"
(replace-regexp-in-string "\\\([@{}]\\\)" "@\\1" text))
;;; Template