Arc Forumnew | comments | leaders | submitlogin
4 points by bootload 6170 days ago | link | parent

"... My super fantasy includes small examples with their outputs. If the Arc team hates this idea, maybe an Arc Wiki is the way to go? ..."

Damn I missed this thread. The examples are exactly the way to go. My idea was something along the lines of a snippets collection by user, title plus code and unique url. [0] This means the good code rises to the top, is stored at arclanguage for all to see and read. Sorted by hacker. At some time in the future it could also be run server-side - something pg has hinted in the past.

"... maybe an Arc Wiki is the way to go? ..."

But this idea is more focussed on describing the code. Is there anyway a code document generator could be written extracting

- filename

- function name

- description

to auto generate the documentation much like Python? [1] This one thing Guido got right - documentation: A tutorial (already exists) and the module index (does not). [2] By having a PyDoc equivalent running over the latest version of Arc you can have a arclanguage.org/doc url with a module index plus the tutorial.

This is how python became so damn useful. You could find how to solve a problem reading both the tutorial, then check the module index to read the details. Sure beats having to do a wiki which arclanguage pretty much covers sans the markup.

[0] http://arclanguage.org/item?id=743

[1] http://docs.python.org/lib/module-pydoc.html

[2] http://docs.python.org/modindex.html