ndwarshuis
/
org-mode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc/org-manual.org: Do not indent example python blocks 

* doc/org-manual.org (Passing arguments):
(Type):
(Noweb Reference Syntax): Do not indent python block examples.  No
indentation should work across different user settings for
`org-src-preserve-indentation', not just for its default value.

Reported-by: Uwe Brauer
Link: https://orgmode.org/list/87o7dn9euy.fsf@mat.ucm.es
This commit is contained in:
Ihor Radchenko 2024-01-15 14:17:06 +01:00
parent 38c6eb2b72
commit 78754cdcff
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/org-manual.org
View File

@ -17913,6 +17913,8 @@ Here are examples of passing values by reference:
not contain any horizontal rule. When set to =no=, Org does not
pre-process column names at all.
# We keep python blocks unindented on purpose - to keep the example
# working even for users who changed the default value of ~org-src-preserve-indentation~
#+begin_example
,#+NAME: less-cols
| a |
@ -17921,7 +17923,7 @@ Here are examples of passing values by reference:
| c |
,#+BEGIN_SRC python :var tab=less-cols :colnames nil
return [[val + '*' for val in row] for row in tab]
return [[val + '*' for val in row] for row in tab]
,#+END_SRC
,#+RESULTS:
@ -17946,7 +17948,7 @@ Here are examples of passing values by reference:
| two | 6 | 7 | 8 | 9 | 10 |
,#+BEGIN_SRC python :var tab=with-rownames :rownames yes
return [[val + 10 for val in row] for row in tab]
return [[val + 10 for val in row] for row in tab]
,#+END_SRC
,#+RESULTS:
@ -18576,6 +18578,8 @@ described in the documentation for individual languages. See
those =hline= symbols raise unbound variable errors. A =yes=
accepts such lines, as demonstrated in the following example.
# We keep python blocks unindented on purpose - to keep the example
# working even for users who changed the default value of ~org-src-preserve-indentation~
#+begin_example
,#+NAME: many-cols
| a | b | c |
@ -18586,7 +18590,7 @@ described in the documentation for individual languages. See
,#+NAME: no-hline
,#+BEGIN_SRC python :var tab=many-cols :hlines no
return tab
return tab
,#+END_SRC
,#+RESULTS: no-hline
@ -18596,7 +18600,7 @@ described in the documentation for individual languages. See
,#+NAME: hlines
,#+BEGIN_SRC python :var tab=many-cols :hlines yes
return tab
return tab
,#+END_SRC
,#+RESULTS: hlines
@ -19435,10 +19439,12 @@ Here is an example that demonstrates how the exported content changes
when noweb style references are used with parentheses versus without.
Given:
# We keep python blocks unindented on purpose - to keep the example
# working even for users who changed the default value of ~org-src-preserve-indentation~
#+begin_example
,#+NAME: some-code
,#+BEGIN_SRC python :var num=0 :results output :exports none
print(num*10)
print(num*10)
,#+END_SRC
#+end_example
@ -19510,15 +19516,17 @@ newlines in them, inline noweb references are acceptable.
This feature can also be used for management of indentation in
exported code snippets. With:
# We keep python blocks unindented on purpose - to keep the example
# working even for users who changed the default value of ~org-src-preserve-indentation~
#+begin_example
,#+NAME: if-true
,#+BEGIN_SRC python :exports none
print('do things when true')
print('do things when true')
,#+end_src
,#+name: if-false
,#+begin_src python :exports none
print('do things when false')
print('do things when false')
,#+end_src
#+end_example
@ -19527,10 +19535,10 @@ this code block:
#+begin_example
,#+begin_src python :noweb yes :results output
if true:
<<if-true>>
else:
<<if-false>>
if true:
<<if-true>>
else:
<<if-false>>
,#+end_src
#+end_example