summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBastien <bzg@gnu.org>2020-05-24 10:13:52 +0200
committerBastien <bzg@gnu.org>2020-05-24 10:13:52 +0200
commit701c7bed94d792a70b8c02f8bd06d276d05a275b (patch)
treecaef1fe9185a4ae51aded77130cfffdea7bd2fd1
parent6d62c76d2c99f5998bbae865db65206f70a9679f (diff)
downloadorg-mode-701c7bed94.tar.gz
lisp/org.el: Minor docstrings enhancements
* lisp/org.el (org-deadline, org-schedule): Update docstrings by mentioning the use of the Emacs calendar. See https://debbugs.gnu.org/cgi/bugreport.cgi?bug=15598
-rw-r--r--lisp/org.el12
1 files changed, 10 insertions, 2 deletions
diff --git a/lisp/org.el b/lisp/org.el
index b3cb302..40c3c46 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -10474,7 +10474,11 @@ TYPE is either `deadline' or `scheduled'. See `org-deadline' or
org-last-inserted-timestamp)))))
(defun org-deadline (arg &optional time)
- "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
+ "Insert a \"DEADLINE:\" string with a timestamp to make a deadline.
+
+When called interactively, this command pops up the Emacs calendar to let
+the user select a date.
+
With one universal prefix argument, remove any deadline from the item.
With two universal prefix arguments, prompt for a warning delay.
With argument TIME, set the deadline at the corresponding date. TIME
@@ -10491,7 +10495,11 @@ can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
(org--deadline-or-schedule arg 'deadline time)))
(defun org-schedule (arg &optional time)
- "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
+ "Insert a \"SCHEDULED:\" string with a timestamp to schedule an item.
+
+When called interactively, this command pops up the Emacs calendar to let
+the user select a date.
+
With one universal prefix argument, remove any scheduling date from the item.
With two universal prefix arguments, prompt for a delay cookie.
With argument TIME, scheduled at the corresponding date. TIME can