summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBastien Guerry <bzg@altern.org>2013-05-21 12:33:36 +0200
committerBastien Guerry <bzg@altern.org>2013-05-21 12:33:36 +0200
commit9eb5fd5dc039f173126ea6cf3b7252229e119f58 (patch)
treed82a16972cc6422a9ca6a5cec69f31f9d2512034
parent4daf9d60d913da6d4d086b05b38974779859a52d (diff)
downloadorg-mode-9eb5fd5dc039f173126ea6cf3b7252229e119f58.tar.gz
org-clock.el (org-clock-modify-effort-estimate): Clarify docstring
* org-clock.el (org-clock-modify-effort-estimate): Clarify docstring. Thanks to Ken Mankoff for raising this.
-rw-r--r--lisp/org-clock.el5
1 files changed, 4 insertions, 1 deletions
diff --git a/lisp/org-clock.el b/lisp/org-clock.el
index 591d0d3..34283a8 100644
--- a/lisp/org-clock.el
+++ b/lisp/org-clock.el
@@ -665,7 +665,10 @@ previous clocking intervals."
"Add to or set the effort estimate of the item currently being clocked.
VALUE can be a number of minutes, or a string with format hh:mm or mm.
When the string starts with a + or a - sign, the current value of the effort
-property will be changed by that amount.
+property will be changed by that amount. When doing so, Org assumes the
+value to modify is either hh:mm or mm, not an effort duration as specified
+in `org-effort-durations' (e.g. \"3h\").
+
This will update the \"Effort\" property of currently clocked item, and
the mode line."
(interactive)