emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/org 78754cdcff 3/3: doc/org-manual.org: Do not indent e


From: ELPA Syncer
Subject: [elpa] externals/org 78754cdcff 3/3: doc/org-manual.org: Do not indent example python blocks
Date: Mon, 15 Jan 2024 09:59:18 -0500 (EST)

branch: externals/org
commit 78754cdcff52e4b89ee5f03984e75341b3a971b0
Author: Ihor Radchenko <yantar92@posteo.net>
Commit: Ihor Radchenko <yantar92@posteo.net>

    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
---
 doc/org-manual.org | 30 +++++++++++++++++++-----------
 1 file changed, 19 insertions(+), 11 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index c8e6d2d8a7..eb77558daa 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -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
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]