Browse Source

org-element: Fix a docstring

* lisp/org-element.el (org-element--remove-indentation): Fix
  docstring.
Nicolas Goaziou 12 years ago
parent
commit
10169054eb
1 changed files with 4 additions and 4 deletions
  1. 4 4
      lisp/org-element.el

+ 4 - 4
lisp/org-element.el

@@ -1650,10 +1650,10 @@ CONTENTS is nil."
 
 (defun org-element--remove-indentation (s &optional n)
   "Remove maximum common indentation in string S and return it.
-When N is a positive integer, remove exactly that indentation,
-possible, or return S as-is otherwise.  Unlike to
-`org-remove-indentation', this function doesn't call `untabify'
-on S first."
+When optional argument N is a positive integer, remove exactly
+that much characters from indentation, if possible, or return
+S as-is otherwise.  Unlike to `org-remove-indentation', this
+function doesn't call `untabify' on S."
   (catch 'exit
     (with-temp-buffer
       (insert s)