[PATCH] documentation fix

[PATCH] documentation fix

[Alex Branham]

[-- Attachment #1: Type: text/plain, Size: 172 bytes --]

Hello,

I tripped myself up by trying to set org-agenda-show-log instead of org-agenda-start-with-log, so hopefully this patch will help other people down the line.

Alex


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-agenda-documentation-addition.patch --]
[-- Type: text/x-diff, Size: 970 bytes --]

From 47e1c3a9cd66d73c01ec0b4072228c02abbe0450 Mon Sep 17 00:00:00 2001
From: Alex Branham <branham@utexas.edu>
Date: Tue, 31 Oct 2017 14:08:00 -0500
Subject: [PATCH] org-agenda: documentation addition

* lisp/org-agenda.el: Add documentation to `org-agenda-show-log'
---
 lisp/org-agenda.el | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 750221e46..39761121a 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -2092,7 +2092,9 @@ evaluate to a string."
 (defvar org-agenda-follow-mode nil)
 (defvar org-agenda-entry-text-mode nil)
 (defvar org-agenda-clockreport-mode nil)
-(defvar org-agenda-show-log nil)
+(defvar org-agenda-show-log nil
+  "If non-nil, show the log in the agenda.
+Do not set this directly; instead use `org-agenda-start-with-log-mode', which see.")
 (defvar org-agenda-redo-command nil)
 (defvar org-agenda-query-string nil)
 (defvar org-agenda-mode-hook nil
-- 
2.15.0

Re: [PATCH] documentation fix

[Nicolas Goaziou]

Hello,

Alex Branham <alex.branham@gmail.com> writes:

> I tripped myself up by trying to set org-agenda-show-log instead of
> org-agenda-start-with-log, so hopefully this patch will help other
> people down the line.

Applied. Thank you.

Regards,

-- 
Nicolas Goaziou