From: gerard.vermeulen@posteo.net
To: Ihor Radchenko <yantar92@posteo.net>
Cc: Emacs orgmode <emacs-orgmode@gnu.org>
Subject: Re: [PATCH] Make command org-babel-detangle work interactively
Date: Sat, 20 Jan 2024 14:10:56 +0000 [thread overview]
Message-ID: <1b0e6cc5b2aefe8269ce8791add80d5c@posteo.net> (raw)
In-Reply-To: <874jf86vvu.fsf@localhost>
[-- Attachment #1: Type: text/plain, Size: 754 bytes --]
On 20.01.2024 13:18, Ihor Radchenko wrote:
> gerard.vermeulen@posteo.net writes:
>
>>> I suspect that you may have some misunderstanding about how
>>> `org-babel-detangle' works. Its docstring says:
>>>
>>> Propagate changes in source file back original to Org file.
>>>
>>> So, it is expected to run from the tangled file; not from the Org
>>> file.
>>
>> Yes, I misunderstood this and I see that my patch breaks this.
>>
>> I think there is a typo in the docstring: "original to" must become
>> "to
>> original"
>> so that it ends with "back to original Org file".
>
> How about the attached patch?
I have attached a modification of your patch. I think it is clearer
with
the risk of being too verbose, but the docstring width is < 80.
[-- Attachment #2: 0001-lisp-ob-tangle.el-org-babel-detangle-Improve-docstri.patch --]
[-- Type: application/octet-stream, Size: 1085 bytes --]
From 2a1b82d6cb97042edbd4ebc6bc07155f50ac8505 Mon Sep 17 00:00:00 2001
From: Ihor Radchenko <yantar92@posteo.net>
Date: Sat, 20 Jan 2024 13:17:43 +0100
Subject: [PATCH] lisp/ob-tangle.el (org-babel-detangle): Improve docstring
---
lisp/ob-tangle.el | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/lisp/ob-tangle.el b/lisp/ob-tangle.el
index 933a3eba1..eea1fca2c 100644
--- a/lisp/ob-tangle.el
+++ b/lisp/ob-tangle.el
@@ -618,9 +618,11 @@ by `org-babel-get-src-block-info'."
;; de-tangling functions
(defun org-babel-detangle (&optional source-code-file)
- "Propagate changes in source file back original to Org file.
+ "Propagate changes from current source buffer back to the original Org file.
This requires that code blocks were tangled with link comments
-which enable the original code blocks to be found."
+which enable the original code blocks to be found.
+
+SOURCE-CODE-FILE is a file path that can be used instead of current buffer."
(interactive)
(save-excursion
(when source-code-file (find-file source-code-file))
--
2.42.0
next prev parent reply other threads:[~2024-01-20 14:11 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-19 12:43 [PATCH] Make command org-babel-detangle work interactively gerard.vermeulen
2024-01-19 15:20 ` Ihor Radchenko
2024-01-19 23:14 ` gerard.vermeulen
2024-01-20 12:18 ` Ihor Radchenko
2024-01-20 14:10 ` gerard.vermeulen [this message]
2024-01-20 18:36 ` Ihor Radchenko
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=1b0e6cc5b2aefe8269ce8791add80d5c@posteo.net \
--to=gerard.vermeulen@posteo.net \
--cc=emacs-orgmode@gnu.org \
--cc=yantar92@posteo.net \
/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).