From 00e4f6b18e08da0e3bc4af83ae171da2a80a1ea0 Mon Sep 17 00:00:00 2001 From: Tue Herlau <tuhe@dtu.dk> Date: Mon, 6 Sep 2021 10:54:16 +0200 Subject: [PATCH] Updates --- README.md | 12 ++++++------ docs/README.jinja.md | 12 ++++++------ docs/latex_nup.pdf | Bin 58941 -> 58941 bytes 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d591146..84f0669 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,9 @@ examples/cs101_students # This directory contains the (processed) student fil examples/cs101_output # This contains automatically generated contents (snippets, etc.). ``` The basic functionality is you insert special comment tags in your source, such as `#!b` or `#!s` and the script then process -the sources based on the tags. The following will show most basic usages: +the sources based on the tags. The following will show most common usages: -## The #f!-tag +## The #!f-tag Let's start with the simplest example, blocking out a function (see `examples/cs101_instructor/f_tag.py`; actually it will work for any scope) You insert a comment like: `#!f <exception message>` like so: ```python @@ -56,7 +56,7 @@ def myfun(a,b): return sm ``` -## The #b!-tag +## The #!b-tag The #!b-tag allows you more control over what is cut out. The instructor file: ```python def primes_sieve(limit): @@ -89,7 +89,7 @@ This allows you to cut out text across scopes, but still allows you to insert ex -## The #s!-tag +## The #!s-tag The #!s-tag is useful for making examples to include in exercises and lecture notes. The #!s (snip) tag cuts out the text between tags and places it in files found in the output-directory. As an example, here is the instructor file: ```python @@ -146,7 +146,7 @@ and finally: I recommend using `\inputminted{filename}` to insert the cutouts in LaTeX. -## The #o!-tag +## The #!o-tag The #!o-tag allows you to capture output from the code, which can be useful when showing students the expected behavior of their scripts. Like the #!s-tag, the #!o-tags can be named. @@ -178,7 +178,7 @@ Area of square of width 2 and height 4 is: and that is a fact! ``` -## The #i!-tag +## The #!i-tag The #!i-tag allows you to create interactive python shell-snippets that can be imported using the minted `pycon` environment (`\inputminted{python}{input.shell}`). As an example, consider the instructor file diff --git a/docs/README.jinja.md b/docs/README.jinja.md index 65b5964..a9fd950 100644 --- a/docs/README.jinja.md +++ b/docs/README.jinja.md @@ -30,9 +30,9 @@ examples/cs101_students # This directory contains the (processed) student fil examples/cs101_output # This contains automatically generated contents (snippets, etc.). ``` The basic functionality is you insert special comment tags in your source, such as `#!b` or `#!s` and the script then process -the sources based on the tags. The following will show most basic usages: +the sources based on the tags. The following will show most common usages: -## The #f!-tag +## The #!f-tag Let's start with the simplest example, blocking out a function (see `examples/cs101_instructor/f_tag.py`; actually it will work for any scope) You insert a comment like: `#!f <exception message>` like so: ```python @@ -47,7 +47,7 @@ The output can be found in `examples/students/f_tag.py`. It will cut out the bod {{ cs101_students.f_tag_py }} ``` -## The #b!-tag +## The #!b-tag The #!b-tag allows you more control over what is cut out. The instructor file: ```python {{ cs101_instructor.b_tag_py }} @@ -60,7 +60,7 @@ This allows you to cut out text across scopes, but still allows you to insert ex -## The #s!-tag +## The #!s-tag The #!s-tag is useful for making examples to include in exercises and lecture notes. The #!s (snip) tag cuts out the text between tags and places it in files found in the output-directory. As an example, here is the instructor file: ```python @@ -87,7 +87,7 @@ and finally: I recommend using `\inputminted{filename}` to insert the cutouts in LaTeX. -## The #o!-tag +## The #!o-tag The #!o-tag allows you to capture output from the code, which can be useful when showing students the expected behavior of their scripts. Like the #!s-tag, the #!o-tags can be named. @@ -104,7 +104,7 @@ and {{ cs101_output.o_tag_b_txt }} ``` -## The #i!-tag +## The #!i-tag The #!i-tag allows you to create interactive python shell-snippets that can be imported using the minted `pycon` environment (`\inputminted{python}{input.shell}`). As an example, consider the instructor file diff --git a/docs/latex_nup.pdf b/docs/latex_nup.pdf index fa0291c368ede566636011afc7503ea060b25631..748d1e30d11150e380afba36ab814fdc6939bd75 100644 GIT binary patch delta 1382 zcmdmchI#K9<_(MPGMgA0PF{Lf0Yq;;arYx*z2>s}1|Ox9_fNc2cdy!ON$`@#8{aa% zThh!a`)0xCcU$%v%kt=5x_H9zRZObz0(FOI?h6iEOJ^UvK2`F_`qiuL9~yM&d_0mk zOKE-GjD%0JMrGXn%fy$~m(JbOY8`2)xqaOwCZ)TF>@VNs7B?xI^!3#0&d;UqdFKB4 ztnvDpt+$?hebt>wx63Z+ZrT{k%G&(?o{#!9-aw6(zH;SR(|UjD*<{ImwuxEQr|tD@ z150$9>W}6PEfGzw2XC~fUg<wP>6Kt<XZ0%~{?*<(V6?{}_K%_Qsp?;o_+NYLfzdvP z_)}L3c24KIW?Oo){i^D8Fna#VsyOFXSg2&ZVN$v4T91=v^QSI!KknyL{I*IZ`}hLW zd})tG9k)6sgh(yB)#P=G+o<gGU!TJomlVwQ_*ypnJk|LkV%N)CoNe3sT&<fTvaXj2 zMNQ1PF(Y`}2c@(=)x<?>(@#8(vi4eZY~`X8XT*9fmY+?_owy~o>cM8oh1)MRyPtVf z+22_b9aeAr{F0-S>bo~upO$)gFn_(cVD*J>Pk&C**U=Hz`DrM-YvN;jEA`#^+rF9m zTP|*NytVv|u!>pjqQ<QnZKjTDk8RX)U3xy9J+|caC*HjRmzO=}H+vm_Htw!n-WlJ_ zhj}ykHoZHx!hVCpdiSNWa+jU9G=JW$9DRr@?}47&1I03fqxE`apB?QE$wlosqJ5^I z!C5A;FIlIcN!9No+xsx)Lvwqkg|7LuY3XI1bMcib3s39m>pu0G9(=wd>2O)e#sj<_ zD(@yaKVZygY+oQ+c0grDlVQtgWu@ame4<yY8qdgPG@fI%yf>G9d;eDR)840^OMWPL z|M%N&UaL=uUpjui_$6|tUj63l8UC|(ef<-&=S-f5ZAs+8K(kFVF6SrZzu{27sXHya zb!$Z3`H%6@Pk3*C-1+tud*!Vnuisn$xaB?E(8~T`;f`G9hKBPCXU$X*y14%S`QNtZ zbN&6c{kQt%bM4;S5;<kLT_4tSo+>T$nUeOX_5LOAyZL`#AIe{v^Xu)b<k=5))^E)G zbWSbrq1nE}vVR<8z6jb^%2_F?S*hvmI?%23wr=y&198(rcYk;naxuhQo-f#+ceB9? zRww!2@A$H~{gdyfl{`G0Y$6+XBWcoC*;)&6xyLu|KKSdlPjs8)ZKc!I6}{Il@7c1q zyD@!cRKiuK?5@j!{bFyQwH|$6(Ov$1vG1As#krpU{n_V)a0_t%aM{PNw46n>gjs9e z+()j8(HA$bD0w-vD$#tGfW_s&D*kJq&%EXF*eTtA@WU?7gD2WVHE&-ldA4$1j$Lw< zQT&6SDS1}Yo7ZX2Q-5#bcvf_+hu_NI;XhaZi9hxH;+yH`4&LAWUh|B#?B5%2&jl`9 zU~O^NtaoMo<TaU-)?`jtQ}Lu|!V%vt-bSexUptt3_E~iBsok%e5W9Z)ONO_(<rDa1 zPlo-OC6s?9a@(<u`ij>aR-R6&5`MJj;F6+qOL#@?&n}K(zwt#deD3l?A0%d;EB&Uh zdRA9}=Fh656EyF7zWBY+abeA}BUTfg=CCkdt(;<~`r$?BieUSCmpN0dv~Q)nsa#jH zrFPf%)XR7I<^Ki*UiF=B_*u*R?z7s)FLypP{&X)FzHO|x{$ASitKWaUT;5%uv%TeO z>4Ce7?Dgtw+uu1(EWdj%y@CC<b-}$qhsys;`rVn|7X1CXANTi7a%<n&7JC+HFTMQq zZ`h1YKW2Zhm#AB!!IheqQd}~5{gX6jb5kcXXEO_D7guLjOA}XPOG7hDS4(qO6C-m& SBUeKMI|Um;N+w4<eF^|6?Yg7@ delta 1382 zcmdmchI#K9<_(MPG8-6~PF{Lf0Yq;;arYx*z2Uq)iI2>W)hX}%yXX59kL4c6lW#NM z@njday5aczZf145l|;;v#S@#a>^!CB;NP%KY(ZnzYqRF{+QuF6;o<d%5=9~(bsjcx zjr(hG@QHQG8!<UweXswotSY(7Hzft-#V%!a+0|OVY_qst#v7H_Q^SRyzrH7F_49e) zwX@aJV(jX_>`>kQc1d(f@^UUNw)=Z$`mK>(6u=?--pxc;`fF^(6`N<3J3?f`r<_UT z+{WYmfjyCPBTIMFMo#Y)^6jcum0t;czoIG^Ha!B2DjIkFNKTvb{fnynwdpZnRMWU` z%F2gD`l4&9Urpj)?X3q!=dPAMyRl{MDx><OBk#JRCQiz=({}Ffo7?j2)>n^feU91p z%qF-9ZWUHsY2ve$b?OxHlsC_Q&uj}^;+Ru0yNKcQRN;#oOD=B}=E;@qE@RnvW!+nq zElM{x7%tCw=z2!R`;bfY`3c9jmQ8W#4R)P4Q&+0cZ}!<+N}0RA97s2I%3sRfKjY|U zIpLSv*3_q+TiV>>b?0X26Yr@L*j_Dm3}5*6^k>!hhzPxiPsvs#%E#+V{L1d<yv?6i z<i^~*#s8+dN6s%7=IlV8>?WUMl|HvRB%aRh^}PO6x=L}G?{WE@Yx`&I-Bo*M#_UUn z?i$Ia-0cmlPiTzm_p-KG)|$coyxe_Ti|CyLu{H;s-z0R^$G&;iT+?E^rJ^%@#zTg7 zi$gNUBOb7L&w0dqZ!KGkwWRLqh^MLE%OmIP|K#B`JvJ`t)KtCY^8}B!y?v3?C_TaB zj%xb><_k>xj@oY;JPlZrIi|b2^evUqTJ@D_ru7A;x!gs2toifgv-77-pK{*#!NYsM z-<C_4JURSA@bks5nltMCH(fWJZ&v#H=gx|mcPCW6*wnN*C&h62{Ui5o2>NY`)>+S$ zz46by$NRUPklyyV`1V!)Pg|Z&`Ih~&_s*e2ZvF$#g}2!l80R~i8hffNir+u~d-c5A z^XBCIFa0ue&EDHDZQN{19>xn#dHraH#@Qp>`<G7Nb^q7(*85&JzuY!GZg#M^KKb&K zxxRM}<<_)Y|7f&$p<MULro_dk#3!btQQY;`-?Y<>dv#WqJ-oYe(aJnKnPu~&(h>u> zTkO8wmAxW1@7TVxFAlXI&#>CF;i$@M>t6+WHpe#ZKKQ%0MmxuNo9ndiAEeeVugt6# zXFhMV^}wpuYa+`R%jw=a%iVqdquBd*?z3mqyWgJlZ$6*JN-+ho51lpgE`FR^FW5qC ztdDj(ZCjKc`0|qR*F$+FiUrFSf00}BeCBP*2}R~|%@0e3n<nyV2W?yX@=UPp&6;Ch zQuZDAeDY3-9(!!KjsLyOrdiri6XyhdU;iom=l&_@7vI#M+q}R0e(;QPt6v*$&t2@} zSYEIzS1Pz(J@T?j<Yk4(k0+igbj}u$W-`6-T98$uwopLUXWw6i-Esbx8E@Twryy%J zY3&bF)q5*8=kzAWJFRI9ntt+&+L6j;&!=-drM2p2x$orL@KSl5m4E9)L!-H`-#CVu ziY^TL^tDSdc-Q0$-<_MCe)@ElDz#d0vaR~8QS0^K;_86qb@d$<+NEJzPTu$&^E2aj z$@|mGcFWuSTDWM{Y`x@Xp?SN`{$_f)^C9!+{&#BI(qrQGo;|nv{nyL>;{R{talU@t zu-lpMpC3=&-DaityY`-E;NMpMV9(Fi_y3IN?6Buu{%-wTv3IGqQFp7KO?ndMwfyw& zwFapl%^%iRxh_%QO3h0tE}6XkNt&~XiK(fnrKPKdi;IDav7@PplbeBovyp*`p_{Rr Rxr?Elf(;=hlOvu!1puR|u)Y8Q -- GitLab