# HG changeset patch # User Chong Yidong # Date 1247938775 0 # Node ID 8f1c96160773fd49b44ab18a9c3366a516006410 # Parent a5f754c1ef7e7d9cdd6775ede9eea646c66333f1 * simple.el (region-active-p, use-region-p): Doc fix (Bug#3873). diff -r a5f754c1ef7e -r 8f1c96160773 lisp/ChangeLog --- a/lisp/ChangeLog Sat Jul 18 11:59:04 2009 +0000 +++ b/lisp/ChangeLog Sat Jul 18 17:39:35 2009 +0000 @@ -1,3 +1,7 @@ +2009-07-18 Chong Yidong + + * simple.el (region-active-p, use-region-p): Doc fix (Bug#3873). + 2009-07-18 Eli Zaretskii * desktop.el (desktop-buffers-not-to-save): Default value is nil. diff -r a5f754c1ef7e -r 8f1c96160773 lisp/simple.el --- a/lisp/simple.el Sat Jul 18 11:59:04 2009 +0000 +++ b/lisp/simple.el Sat Jul 18 17:39:35 2009 +0000 @@ -3559,23 +3559,25 @@ (defun use-region-p () "Return t if the region is active and it is appropriate to act on it. This is used by commands that act specially on the region under -Transient Mark mode. It returns t if and only if Transient Mark -mode is enabled, the mark is active, and the region is non-empty. -If `use-empty-active-region' is non-nil, it returns t even if the -region is empty. - -For some commands, it may be appropriate to disregard the value -of `use-empty-active-region'; in that case, use `region-active-p'." +Transient Mark mode. + +The return value is t provided Transient Mark mode is enabled and +the mark is active; and, when `use-empty-active-region' is +non-nil, provided the region is empty. Otherwise, the return +value is nil. + +For some commands, it may be appropriate to ignore the value of +`use-empty-active-region'; in that case, use `region-active-p'." (and (region-active-p) (or use-empty-active-region (> (region-end) (region-beginning))))) (defun region-active-p () "Return t if Transient Mark mode is enabled and the mark is active. -Most commands that act on the region if it is active and -Transient Mark mode is enabled, and on the text near point -otherwise, should use `use-region-p' instead. That function -checks the value of `use-empty-active-region' as well." +Some commands act specially on the region when Transient Mark +mode is enabled. Usually, such commands should use +`use-region-p' instead of this function, because `use-region-p' +also checks the value of `use-empty-active-region'." (and transient-mark-mode mark-active)) (defvar mark-ring nil