summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Goaziou <mail@nicolasgoaziou.fr>2018-03-18 21:26:42 +0100
committerNicolas Goaziou <mail@nicolasgoaziou.fr>2018-03-18 21:26:42 +0100
commite1f1acbbfb07ca49f857672a1f0648052753568f (patch)
tree2a703e54a7809f58ebc2a7e9ee6d609672f92644
parentea4cb148832a09b168bcf2a46dec385684225420 (diff)
downloadorg-mode-e1f1acbbfb07ca49f857672a1f0648052753568f.tar.gz
Improve docstring for `org-time-stamp-inactive'
* lisp/org.el (org-time-stamp-inactive): Improve docstring.
-rw-r--r--lisp/org.el10
1 files changed, 9 insertions, 1 deletions
diff --git a/lisp/org.el b/lisp/org.el
index 859f3df..e08cda8 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -16629,10 +16629,18 @@ non-nil."
(defun org-time-stamp-inactive (&optional arg)
"Insert an inactive time stamp.
+
An inactive time stamp is enclosed in square brackets instead of angle
brackets. It is inactive in the sense that it does not trigger agenda entries,
does not link to the calendar and cannot be changed with the S-cursor keys.
-So these are more for recording a certain time/date."
+So these are more for recording a certain time/date.
+
+If the user specifies a time like HH:MM or if this command is called with
+at least one prefix argument, the time stamp contains the date and the time.
+Otherwise, only the date is included.
+
+When called with two universal prefix arguments, insert an active time stamp
+with the current time without prompting the user."
(interactive "P")
(org-time-stamp arg 'inactive))