Browse Source

ox-texinfo: Fix docstrings

* lisp/ox-texinfo.el (org-texinfo--sanitize-menu,
  org-texinfo--sanitize-content): Fix docstrings.
Nicolas Goaziou 10 years ago
parent
commit
2ef63acae2
1 changed files with 5 additions and 8 deletions
  1. 5 8
      lisp/ox-texinfo.el

+ 5 - 8
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