Margin Notes: Automatic code documentation with recorded examples from runtime

Re:Margin Notes: Automatic code documentation with recorded ... by chewxy on Tuesday November 27, 2018 @11:24PM (#18549276)

Slightly related are Go examples - they're tests, and documentation at the same time. It'd be nice if someone hooks in a listener to automatically collect examples tho

[ Parent | on HN ]

Re:Margin Notes: Automatic code documentation with recorded ... by pmontra on Wednesday November 28, 2018 @05:39PM (#18556353)

And Elixir's doctests https://elixir-lang.org/getting-started/mix-otp/docs-tests-a...

[ Parent | on HN ]

Re:Margin Notes: Automatic code documentation with recorded ... by merlincorey on Wednesday November 28, 2018 @05:47PM (#18556415)

And Python's Axe!

I mean doctest: https://docs.python.org/3/library/doctest.html

[ Parent | on HN ]

Re:Margin Notes: Automatic code documentation with recorded ... by westurner on Thursday November 29, 2018 @06:03AM (#18559384)

1. sys.settrace() for {call, return, exception, c_call, c_return, and c_exception}

2. Serialize as/to doctests. Is there a good way to serialize Python objects as Python code?

3. Add doctests to callables' docstrings with AST

Mutation testing tools may have already implemented serialization to doctests but IDK about docstring modification.

... MOSES is an evolutionary algorithm that mutates and simplifies a combo tree until it has built a function with less error for the given input/output pairs.

[ Parent | on HN ]

Re:Margin Notes: Automatic code documentation with recorded ... by gklitt on Wednesday November 28, 2018 @07:08PM (#18556934)

Yeah, I like doctests but also find it limiting to have everything in the source code text. Having a GUI for viewing examples is nice, although it does introduce other problems like how to store and version the examples.

[ Parent | on HN ]