[PATCH] Improve formatting and documentation inline source block [9.3 (release_9.3 @ /usr/local/share/emacs/28.0.50/lisp/org/)]

[Ihor Radchenko <yantar92@gmail.com>]

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

dalanicolai <dalanicolai@gmail.com> writes:

> This bug report contains two requests/bugs about inline source blocks
> namely:
>
> 1. Inline source blocks don't get formatted/propertized within
> org buffers.

There is now patch under review to fix this:
https://list.orgmode.org/87h7dy7f68.fsf@localhost/T/#t

> 2. Different from ordinary source blocks, the inline source blocks
> require the [:exports code] argument to get exported. I think it would
> be useful to mention it explicitly in [section 15.2 of the
> documentation](https://orgmode.org/manual/Structure-of-Code-Blocks.html),
> because it is somewhat unexpected behavior (compared to ordinary source
> blocks).

I agree that current manual is confusing.  The attached patch.

Dear all,

Maybe we also want to mention org-babel-default-inline-header-args in
the manual?  In addition to org-babel-default-header-args.

Best,
Ihor


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-orgmanual-org-Mention-results-export-as-default-for-.patch --]
[-- Type: text/x-diff, Size: 1714 bytes --]

From 4f04548dc94549b9e50f6598636632e67715d9b8 Mon Sep 17 00:00:00 2001
Message-Id: <4f04548dc94549b9e50f6598636632e67715d9b8.1633245750.git.yantar92@gmail.com>
From: Ihor Radchenko <yantar92@gmail.com>
Date: Sun, 3 Oct 2021 15:20:18 +0800
Subject: [PATCH] orgmanual-org: Mention results export as default for inline
 src blocks

* doc/org-manual.org (Exporting Code Blocks): Clarify that results are
exported by default for inline source blocks.

The issue has been reported in https://orgmode.org/list/CACJP=3n_8tqzBZ7GhmD+f44NPPTLBy31htxHxRHsELXTeMoy2Q@mail.gmail.com
---
 doc/org-manual.org | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index b25da7889..6403b5e69 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -18002,10 +18002,11 @@ ** Exporting Code Blocks
 It is possible to export the /code/ of code blocks, the /results/ of
 code block evaluation, /both/ the code and the results of code block
 evaluation, or /none/.  Org defaults to exporting /code/ for most
-languages.  For some languages, such as ditaa, Org defaults to
-/results/.  To export just the body of code blocks, see [[*Literal
-Examples]].  To selectively export sub-trees of an Org document, see
-[[*Exporting]].
+languages and /results/ for inline code blocks.  For some languages,
+such as ditaa, Org defaults to /results/ both in ordinary source
+blocks and in inline source blocks.  To export just the body of code
+blocks, see [[*Literal Examples]].  To selectively export sub-trees of an
+Org document, see [[*Exporting]].
 
 #+cindex: @samp{exports}, header argument
 The =exports= header argument is to specify if that part of the Org
-- 
2.32.0