org-element: Fix a docstring

* lisp/org-element.el (org-element--remove-indentation): Fix
  docstring.
This commit is contained in:
Nicolas Goaziou 2013-05-25 17:07:38 +02:00
parent 87ab99f563
commit 10169054eb
1 changed files with 4 additions and 4 deletions

View File

@ -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)