[PATCH] add :tree-type 'month' in org-capture-templates description (and fix documentation about that)

[PATCH] add :tree-type 'month' in org-capture-templates description (and fix documentation about that)

[Florian Dufour]

[-- Attachment #1.1.1: Type: text/plain, Size: 408 bytes --]

Hi!

I noticed one typo in org-manual.org: 'month' value for 'tree-type'
property should not be @code{month} but only 'month'.

Moreover, I added this 'month' value to org-capture-templates
description in org-capture.el.

This is just documentation, but I had to read to code in order to use
this new value (which is awesome).

Feel free to merge this patch if you want!

Cheers,
-- 
Florian

[-- Attachment #1.1.2: 0001-org-capture.el-Add-tree-type-month-in-org-capture-te.patch --]
[-- Type: text/plain, Size: 1887 bytes --]

From eabd16e7530aed5ecdd636b7c55d03d644b02df9 Mon Sep 17 00:00:00 2001
From: Florian Dufour <florian.dufour@posteo.net>
Date: Wed, 25 Nov 2020 11:41:48 +0100
Subject: [PATCH] org-capture.el: Add :tree-type 'month' in
 org-capture-templates description

* lisp/org-capture.el (org-capture-templates): Enhance description
(org-capture-templates): add 'month' value for :tree-type in description

* doc/org-manual.org: Fix typo for displaying 'month' in :tree-type property
---
 doc/org-manual.org  | 2 +-
 lisp/org-capture.el | 4 +++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 2f7f5f847..a0a82cac6 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -7730,7 +7730,7 @@ Now lets look at the elements of a template definition.  Each entry in
 
     Use ~week~ to make a week tree instead of the month-day tree,
     i.e., place the headings for each day under a heading with the
-    current ISO week.  Use @code{month} to group entries by month
+    current ISO week.  Use ~month~ to group entries by month
     only.  Default is to group entries by day.
 
   - ~:unnarrowed~ ::
diff --git a/lisp/org-capture.el b/lisp/org-capture.el
index 020feb4d6..8bd233d15 100644
--- a/lisp/org-capture.el
+++ b/lisp/org-capture.el
@@ -270,7 +270,9 @@ properties are:
  :time-prompt        Prompt for a date/time to be used for date/week trees
                      and when filling the template.
 
- :tree-type          When `week', make a week tree instead of the month tree.
+ :tree-type          When `week', make a week tree instead of the month-day
+                     tree.  When `month', make a month tree instead of the
+                     month-day tree.
 
  :unnarrowed         Do not narrow the target buffer, simply show the
                      full buffer.  Default is to narrow it so that you
-- 
2.29.0


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH] add :tree-type 'month' in org-capture-templates description (and fix documentation about that)

[Kyle Meyer]

Florian Dufour writes:

> Hi!
>
> I noticed one typo in org-manual.org: 'month' value for 'tree-type'
> property should not be @code{month} but only 'month'.

Good catch.

> Moreover, I added this 'month' value to org-capture-templates
> description in org-capture.el.

And this too.  It looks like this spot was missed when the new value was
added in 9.4.

> This is just documentation, but I had to read to code in order to use
> this new value (which is awesome).
>
> Feel free to merge this patch if you want!

Applied (ccf81be2a), with a few tweaks to the commit message.

Thanks!