From mboxrd@z Thu Jan 1 00:00:00 1970 From: Kyle Meyer Subject: Re: org-babel-capitalize-example-region-markers Date: Wed, 25 Jan 2017 00:17:08 -0500 Message-ID: <87bmuvlnvv.fsf@kyleam.com> References: <87r33rn81o.fsf@kyleam.com> Mime-Version: 1.0 Content-Type: text/plain Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:53432) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cWFxN-0002Dy-RF for emacs-orgmode@gnu.org; Wed, 25 Jan 2017 00:17:19 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cWFxL-0004Zo-4V for emacs-orgmode@gnu.org; Wed, 25 Jan 2017 00:17:17 -0500 Received: from pb-smtp2.pobox.com ([64.147.108.71]:60924 helo=sasl.smtp.pobox.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1cWFxL-0004Zi-0I for emacs-orgmode@gnu.org; Wed, 25 Jan 2017 00:17:15 -0500 List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: "Emacs-orgmode" To: Vicente Vera Cc: emacs-orgmode Kyle Meyer writes: [...] >> Shouldn't this variable be public through the customize interface? > > Yes, I think it should be. And it would be consistent with > org-babel-results-keyword being a defcustom. [...] >> Also, it seems "capitalize" is the wrong verb here? > > Something with "upcase" or "uppercase" would have been better given the > behavior of upcase and capitalize. Here's a patch. I'll apply it to master in a day or two if there are no objections. -- >8 -- Subject: [PATCH] ob-core: Add org-babel-uppercase-example-markers option * lisp/ob-core.el (org-babel-capitalize-example-region-markers): Mark as obsolete. (org-babel-uppercase-example-markers): New defcustom to replace defvar org-babel-capitalize-example-region-markers. (org-babel-examplify-region): Use new option. Rather than moving org-babel-capitalize-example-region-markers to a defcustom, give the option a new name that makes it clearer that all characters, not just the first, will be in upper case. Suggested-by: Vicente Vera --- etc/ORG-NEWS | 7 +++++++ lisp/ob-core.el | 13 +++++++++---- lisp/org-compat.el | 3 +++ 3 files changed, 19 insertions(+), 4 deletions(-) diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index fdce28b1d..58875009f 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -218,6 +218,13 @@ document with ~org-mark-ring-goto~ (default binding =C-c &=). *** ~org-get-heading~ accepts two more optional arguments See docstring for details. + +*** New option ~org-babel-uppercase-example-markers~ + +This variable is a ~defcustom~ and replaces the variable +~org-babel-capitalize-example-region-markers~, which is a ~defvar~ and +is now obselete. + * Version 9.0 ** Incompatible changes diff --git a/lisp/ob-core.el b/lisp/ob-core.el index 663fe18b0..d312f2ceb 100644 --- a/lisp/ob-core.el +++ b/lisp/ob-core.el @@ -179,6 +179,14 @@ (defcustom org-babel-hash-show-time nil :package-version '(Org . "9.0") :safe #'booleanp) +(defcustom org-babel-uppercase-example-markers nil + "When non-nil, begin/end example markers will be inserted in upper case." + :group 'org-babel + :type 'boolean + :version "25.2" + :package-version '(Org . "9.1") + :safe #'booleanp) + (defun org-babel-noweb-wrap (&optional regexp) (concat org-babel-noweb-wrap-start (or regexp "\\([^ \t\n].+?[^ \t]\\|[^ \t\n]\\)") @@ -2435,15 +2443,12 @@ (defun org-babel-result-to-file (result &optional description) result) (if description (concat "[" description "]") "")))) -(defvar org-babel-capitalize-example-region-markers nil - "Make true to capitalize begin/end example markers inserted by code blocks.") - (defun org-babel-examplify-region (beg end &optional results-switches inline) "Comment out region using the inline `==' or `: ' org example quote." (interactive "*r") (let ((maybe-cap (lambda (str) - (if org-babel-capitalize-example-region-markers (upcase str) str)))) + (if org-babel-uppercase-example-markers (upcase str) str)))) (if inline (save-excursion (goto-char beg) diff --git a/lisp/org-compat.el b/lisp/org-compat.el index 152c6e7d5..948bd06fb 100644 --- a/lisp/org-compat.el +++ b/lisp/org-compat.el @@ -195,6 +195,9 @@ (define-obsolete-function-alias 'org-agenda-todayp 'org-agenda-today-p "Org 9.0") (define-obsolete-function-alias 'org-babel-examplize-region 'org-babel-examplify-region "Org 9.0") +(define-obsolete-variable-alias 'org-babel-capitalize-example-region-markers + 'org-babel-uppercase-example-markers "Org 9.1") + (define-obsolete-function-alias 'org-babel-trim 'org-trim "Org 9.0") (define-obsolete-variable-alias 'org-html-style 'org-html-head "24.4") (define-obsolete-function-alias 'org-insert-columns-dblock -- 2.11.0