diff --git a/notes/literate-programming.org b/notes/literate-programming.org index 098cf14..fd9b510 100644 --- a/notes/literate-programming.org +++ b/notes/literate-programming.org @@ -2,6 +2,7 @@ #+AUTHOR: Christopher James Hayward #+HUGO_BASE_DIR: ~/.local/source/website +#+HUGO_AUTO_SET_LASTMOD: t #+HUGO_SECTION: notes + Programming paradigm @@ -35,7 +36,7 @@ An essayist concerned with exposition and excellence of style. Someone who caref |_____| -> Send to Customer #+end_example -Illustrated above we see the process of *weaving* and *tangling* the literate source file ~org~, and how each of the produced components is handled respectively. It's not difficult to imagine a situation where an update to a program would update the all of the interested parties. Source code is typically built and tested without requiring the documentation, and in the same sense someone providing support for an application should not be required to dig through the source code to locate documentation. +Illustrated above we see the process of *weaving* and *tangling* the literate source file, and how each of the produced components is handled respectively. | File | Description | |------+------------------------------| @@ -43,6 +44,8 @@ Illustrated above we see the process of *weaving* and *tangling* the literate so | src | Machine readable source code | | doc | Human readable documentation | +It's not difficult to imagine a situation where an update to a program would update the all of the interested parties. Source code is typically built and tested without requiring the documentation, and in the same sense someone providing support for an application should not be required to dig through the source code to locate documentation. + * Resources [fn:knuth-1984] Knuth, D. E. (1984). Literate Programming. The Computer Journal, 27(2), 97–111. https://doi.org/10.1093/comjnl/27.2.97