emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Alex Branham <alex.branham@gmail.com>
To: org-mode-email <emacs-orgmode@gnu.org>
Subject: [PATCH] documentation fix
Date: Tue, 31 Oct 2017 14:12:03 -0500	[thread overview]
Message-ID: <87po93yvwc.fsf@gmail.com> (raw)

[-- 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


             reply	other threads:[~2017-10-31 19:12 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-31 19:12 Alex Branham [this message]
2018-01-06  9:20 ` [PATCH] documentation fix Nicolas Goaziou

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87po93yvwc.fsf@gmail.com \
    --to=alex.branham@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).