[PATCH] org-element.el: Update comment

[PATCH] org-element.el: Update comment

[Leo Vivier]

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

Hi there,

I’ve noticed that a comment on the caching of org-element wasn’t up to
date, so I went ahead and updated it.  I’ve also fixed a missing quote
for one of the variables.

HTH,

-- 
Leo Vivier

[-- Attachment #2: 0001-org-element.el-Update-comment.patch --]
[-- Type: text/x-patch, Size: 1598 bytes --]

From bf1fcc1c0650c30e1e12244df084ab344a2cac59 Mon Sep 17 00:00:00 2001
From: Leo Vivier <leo.vivier+dev@gmail.com>
Date: Tue, 9 Jun 2020 09:57:03 +0200
Subject: [PATCH] org-element.el: Update comment
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* lisp/org-element.el (org-element-normalize-contents): Update comment

The comment mentions that caching for `org-elements' is enabled by
default, but this isn’t the case anymore since
bbdecd1e64a07b3821714d905a58eaca12828cb6, cf. `org-element-use-cache'.
---
 lisp/org-element.el | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/lisp/org-element.el b/lisp/org-element.el
index ac41b7650..a5641e6ee 100644
--- a/lisp/org-element.el
+++ b/lisp/org-element.el
@@ -4821,10 +4821,12 @@ indentation removed from its contents."
 ;;
 ;; A single public function is provided: `org-element-cache-reset'.
 ;;
-;; Cache is enabled by default, but can be disabled globally with
+;; Cache is disabled by default for now because it sometimes triggers
+;; freezes, but it can be enabled globally with
 ;; `org-element-use-cache'.  `org-element-cache-sync-idle-time',
-;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
-;; can be tweaked to control caching behavior.
+;; `org-element-cache-sync-duration' and
+;; `org-element-cache-sync-break' can be tweaked to control caching
+;; behavior.
 ;;
 ;; Internally, parsed elements are stored in an AVL tree,
 ;; `org-element--cache'.  This tree is updated lazily: whenever
-- 
2.26.2

Re: [PATCH] org-element.el: Update comment

[Nicolas Goaziou]

Hello,

Leo Vivier <leo.vivier+dev@gmail.com> writes:

> I’ve noticed that a comment on the caching of org-element wasn’t up to
> date, so I went ahead and updated it.  I’ve also fixed a missing quote
> for one of the variables.

Applied. Thank you.

Regards,

-- 
Nicolas Goaziou