branch: elpa/paredit
commit ba0de55ad6fbc8501cd713dc751046e773296c16
Author: Taylor R Campbell <[email protected]>
Commit: Taylor R Campbell <[email protected]>
Add brief docstring to `paredit-check-region-state'.
Ignore-this: 3f246298c4207e54bdecd05647c0c8fd
darcs-hash:20110410005917-00fcc-7fbd486327b26986ca2b30698a4c1e07b1b1b326
---
paredit.el | 3 +++
1 file changed, 3 insertions(+)
diff --git a/paredit.el b/paredit.el
index 8cd3e19..2f27690 100644
--- a/paredit.el
+++ b/paredit.el
@@ -1701,6 +1701,9 @@ If that text is unbalanced, signal an error instead."
(kill-region beginning end))
(defun paredit-check-region-state (beginning-state end-state)
+ "Signal an error if the two parse-partial-sexp states differ.
+This guarantees that excising the text between the two states'
+ points from the buffer will leave the buffer balanced."
(paredit-check-region-state-depth beginning-state end-state)
(paredit-check-region-state-string beginning-state end-state)
(paredit-check-region-state-comment beginning-state end-state)
