📕 subnode [[@karlicoss/literate]] in 📚 node [[literate]]
📓 garden/karlicoss/programming/literate.md by @karlicoss

Table of Contents

related [[programming]]

[2019-09-24] it started bothering me increasingly. formulating thoughts is hard and when you've came up and TODO shaped? good atom of information, last thing you want to do is duplicate it.

it gets worse when you have different markdown formats (e.g. RST for python)

why org is superior for readmes [[toblog]] [[org]]

org-babel (search by beginsrc) in my readmes
comments?

defining custom language on top of existing, e.g. demonstrating static analysis tools

[2019-08-18] tried to use cog, but it doesn't really work well for interacting with python functions [[literate]] [[python]]

-----

[2019-09-23] NiklasRosenstein/pydoc-markdown: Create Python API documentation in Markdown format.

https://github.com/NiklasRosenstein/pydoc-markdown

<https://mastodon.social/@vertigo/103490093047542336 > [[literate]]

<https://post.lurk.org/@paul/103516477971137544 > [[literate]]

[2019-09-01] docopt—language for description of command-line interfaces http://docopt.org/ [[literate]]

docopt helps you:

define the interface for your command-line app, and
automatically generate a parser for it.

docopt is based on conventions that have been used for decades in help messages and man pages for describing a program's interface. An interface description in docopt is such a help message, but formalized. Here is an example:

[2020-01-19] Noweb home page [[literate]]

https://www.cs.tufts.edu/~nr/noweb 

Noweb — A Simple, Extensible Tool for Literate Programming

[2019-09-15] Automatic code documentation with recorded examples from runtime [[literate]]

https://www.geoffreylitt.com/margin-notes

[2020-05-20] Why does it need a metric ton of permissions? To everything - data, history, not… | Hacker News [[literate]] [[security]] [[webext]]

Why does it need a metric ton of permissions? To everything - data, history, notifications etc.

literate permissions?

[2019-08-14] Pycco - Beautiful Literate Python : Python [[literate]] [[python]]

https://www.reddit.com/r/Python/comments/ekked/pycco_beautiful_literate_python/ 

I'd rather use something that processes docstrings. Using comments like this doesn't feel very Pythonic.

pycco for literate python programming…

[2019-08-21] eh, it's a bit too linear

[2020-04-13] Pollen: the book is a program [[literate]]

Pollen: the book is a program

[2020-05-19] The magic notebook for exploring data / Observable [[js]] [[literate]]

[2021-02-11] ugh. it kinda sucked

  • can't run notebook locally
  • can't preserver the outputs
  • can't export to static HTML

mpastell/Pweave: Pweave is a scientific report generator and a literate programming tool for Python. It can capture the results and plots from data analysis and works well with numpy, scipy and matplotlib.

https://github.com/mpastell/Pweave

example of using –help or doc [[kobuddy]]

benefit is that your source becomes literate and you can keep doc next to source code

[2019-10-26] Literal examples - The Org Manual https://www.gnu.org/software/emacs/manual/html_node/org/Literal-examples.html

[2020-02-12] Show HN: Anansi – a NoWeb-inspired literate programming preprocessor | Hacker News https://news.ycombinator.com/item?id=17484093

In practice, very few pieces of software are written in a way that lends itself to a cohesive narrative. Software is written by numerous developers, layer by layer, often with hacks thrown in. New people come on, don't understand the whole thing, change parts of it, and move on. The requirements change, and the system contorts itself to serve multiple purposes that weren't envisioned by the original coders.

[2020-01-26] literate-readme · GitHub Topics

https://github.com/topics/literate-readme

📖 stoas
⥱ context
To see links, go up to full node [[literate]].