From 2ef63acae2850a88eef3749bc734305a00d9e5d0 Mon Sep 17 00:00:00 2001 From: Nicolas Goaziou Date: Sun, 10 Aug 2014 22:55:20 +0200 Subject: [PATCH] ox-texinfo: Fix docstrings * lisp/ox-texinfo.el (org-texinfo--sanitize-menu, org-texinfo--sanitize-content): Fix docstrings. --- lisp/ox-texinfo.el | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/lisp/ox-texinfo.el b/lisp/ox-texinfo.el index 689247135..712bf1a99 100644 --- a/lisp/ox-texinfo.el +++ b/lisp/ox-texinfo.el @@ -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 -- 2.11.4.GIT