~bzg/org-mode

e7e37c5b26445a2e8f354a4d9bc034c1785c7abb — Stefan Kangas 10 days ago 4a0d951
org-agenda.el: Improve docstrings of agenda date navigation commands

* lisp/org-agenda.el (org-agenda-goto-date)
(org-agenda-goto-today, org-agenda-later, org-agenda-earlier):
Improve documentation and add crossreferences.
1 files changed, 30 insertions(+), 6 deletions(-)

M lisp/org-agenda.el
M lisp/org-agenda.el => lisp/org-agenda.el +30 -6
@@ 8797,7 8797,16 @@ Negative selection means regexp must not match for selection of an entry."
  (set var (concat (symbol-value var) string)))

(defun org-agenda-goto-date (date)
  "Jump to DATE in agenda."
  "Jump to DATE in the agenda buffer.

When called interactively, prompt for the date.
When called from Lisp, DATE should be a date as returned by
`org-read-date'.

See also:
 `org-agenda-earlier'    (\\[org-agenda-earlier])
 `org-agenda-later'      (\\[org-agenda-later])
 `org-agenda-goto-today' (\\[org-agenda-goto-today])"
  (interactive
   (list
    (let ((org-read-date-prefer-future org-agenda-jump-prefer-future))


@@ 8829,7 8838,12 @@ Negative selection means regexp must not match for selection of an entry."
	    org-agenda-this-buffer-is-sticky org-agenda-sticky))))

(defun org-agenda-goto-today ()
  "Go to today."
  "Go to today's date in the agenda buffer.

See also:
 `org-agenda-later'     (\\[org-agenda-later])
 `org-agenda-earlier'   (\\[org-agenda-earlier])
 `org-agenda-goto-date' (\\[org-agenda-goto-date])"
  (interactive)
  (org-agenda-check-type t 'agenda)
  (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))


@@ 8888,8 8902,13 @@ When optional argument BACKWARD is set, go backward."
	       (message "No %s block" (if backward "previous" "further")))))))

(defun org-agenda-later (arg)
  "Go forward in time by the current span.
With prefix ARG, go forward that many times the current span."
  "Go forward in time by the current span in the agenda buffer.
With prefix ARG, go forward that many times the current span.

See also:
 `org-agenda-earlier'    (\\[org-agenda-earlier])
 `org-agenda-goto-today' (\\[org-agenda-goto-today])
 `org-agenda-goto-date'  (\\[org-agenda-goto-date])"
  (interactive "p")
  (org-agenda-check-type t 'agenda)
  (let* ((wstart (window-start))


@@ 8930,8 8949,13 @@ With prefix ARG, go forward that many times the current span."
    (set-window-start nil wstart)))

(defun org-agenda-earlier (arg)
  "Go backward in time by the current span.
With prefix ARG, go backward that many times the current span."
  "Go backward in time by the current span in the agenda buffer.
With prefix ARG, go backward that many times the current span.

See also:
 `org-agenda-later'      (\\[org-agenda-later])
 `org-agenda-goto-today' (\\[org-agenda-goto-today])
 `org-agenda-goto-date'  (\\[org-agenda-goto-date])"
  (interactive "p")
  (org-agenda-later (- arg)))