branch: externals/org
commit ff848a09bb8f4477665a9f52a91b3d794d225270
Author: Ihor Radchenko <[email protected]>
Commit: Ihor Radchenko <[email protected]>
org-edit-src-code: Clarify that passing CODE will make buffer read-only
* lisp/org-src.el (org-edit-src-code): Update the docstring
documenting that passing CODE will create independent read-only code
buffer that will not affect the block at point, even if changed.
This particular feature is used in `org-babel-expand-src-block'.
Reported-by: hiecaq <[email protected]>
Link: https://orgmode.org/list/87y0mtm9a5.fsf@localhost
---
lisp/org-src.el | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/lisp/org-src.el b/lisp/org-src.el
index 31d210a40e..53b44e55e6 100644
--- a/lisp/org-src.el
+++ b/lisp/org-src.el
@@ -1327,8 +1327,9 @@ original code in the Org buffer, and replace it with the
edited
version. See `org-src-window-setup' to configure the display of
windows containing the Org buffer and the code buffer.
-When optional argument CODE is a string, edit it in a dedicated
-buffer instead.
+When optional argument CODE is a string, edit it in a read-only buffer
+instead. The contents of that buffer will *not* be written back to
+the source of example block at point.
When optional argument EDIT-BUFFER-NAME is non-nil, use it as the
name of the sub-editing buffer."
