diff options
| author | Bastien Guerry <bzg@altern.org> | 2013-03-05 14:44:01 +0100 |
|---|---|---|
| committer | Bastien Guerry <bzg@altern.org> | 2013-03-05 16:38:33 +0100 |
| commit | 54ffb0befff9202d40da27fdc87f4cc3a6369c9c (patch) | |
| tree | e986d34a16e66e62420a171ab1ed2c3940a014d0 | |
| parent | fe23891b2ad99f140af43215640e87b6afb32073 (diff) | |
| download | org-mode-54ffb0befff9202d40da27fdc87f4cc3a6369c9c.tar.gz | |
org-agenda.el: Fix or add docstrings.
* org-agenda.el (org-agenda-format-date-aligned)
(org-agenda-time-of-day-to-ampm-maybe)
(org-scheduled-past-days)
(org-agenda-normalize-custom-commands)
(org-agenda-run-series, org-store-agenda-views): Fix or add
docstring.
| -rw-r--r-- | lisp/org-agenda.el | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el index 20e3761..c2fc14a 100644 --- a/lisp/org-agenda.el +++ b/lisp/org-agenda.el @@ -1094,7 +1094,7 @@ a calendar-style date list like (month day year)." (function :tag "Function"))) (defun org-agenda-format-date-aligned (date) - "Format a date string for display in the daily/weekly agenda, or timeline. + "Format a DATE string for display in the daily/weekly agenda, or timeline. This function makes sure that dates are aligned for easy reading." (require 'cal-iso) (let* ((dayname (calendar-day-name date)) @@ -1147,8 +1147,7 @@ For example, 9:30am would become 09:30 rather than 9:30." ":" minute ampm))) (defun org-agenda-time-of-day-to-ampm-maybe (time) - "Conditionally convert TIME to AM/PM format -based on `org-agenda-timegrid-use-ampm'" + "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'." (if org-agenda-timegrid-use-ampm (org-agenda-time-of-day-to-ampm time) time)) @@ -1203,7 +1202,7 @@ shown, either today or the nearest into the future." (const :tag "Don't show repeating stamps" nil))) (defcustom org-scheduled-past-days 10000 - "No. of days to continue listing scheduled items that are not marked DONE. + "Number of days to continue listing scheduled items not marked DONE. When an item is scheduled on a date, it shows up in the agenda on this day and will be listed until it is marked done for the number of days given here." @@ -2767,6 +2766,7 @@ Agenda views are separated by `org-agenda-block-separator'." (org-agenda-fit-window-to-buffer))) (defun org-agenda-normalize-custom-commands (cmds) + "Normalize custom commands CMDS." (delq nil (mapcar (lambda (x) @@ -2980,6 +2980,7 @@ L Timeline for current buffer # List stuck projects (!=configure) (defvar org-agenda-overriding-arguments nil) (defvar org-agenda-overriding-cmd-arguments nil) (defun org-agenda-run-series (name series) + "Run agenda NAME as a SERIES of agenda commands." (org-let (nth 1 series) '(org-agenda-prepare name)) ;; We need to reset agenda markers here, because when constructing a ;; block agenda, the individual blocks do not do that. @@ -3149,6 +3150,7 @@ This ensures the export commands can easily use it." ;;;###autoload (defun org-store-agenda-views (&rest parameters) + "Store agenda views." (interactive) (eval (list 'org-batch-store-agenda-views))) |