org-clock.el (org-clock-modify-effort-estimate): Clarify docstring
authorBastien Guerry <bzg@altern.org>
Tue, 21 May 2013 10:33:36 +0000 (12:33 +0200)
committerBastien Guerry <bzg@altern.org>
Tue, 21 May 2013 10:33:36 +0000 (12:33 +0200)
* org-clock.el (org-clock-modify-effort-estimate): Clarify
docstring.

Thanks to Ken Mankoff for raising this.

lisp/org-clock.el

index 591d0d3..34283a8 100644 (file)
@@ -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)