Arc Forumnew | comments | leaders | submitlogin
Docs?
4 points by hsmyers 6058 days ago | 4 comments
Is Arc too young for documentation?


5 points by cadaver 6058 days ago | link

Here are some links: http://ycombinator.com/arc/tut.txt http://arcfn.com/foundation-doc.html http://practical-scheme.net/wiliki/arcxref?Release%3aarc0

-----

3 points by sjs 6057 days ago | link

If you get the git "wiki"[1] (open commit access) there are docstrings for many fns & macros, and the docs can be accessed from the repl using (help <name>), fns matching a prefix can be listed, e.g. (fns "m").

As a bonus, if you fire up (asv) and browse to http://localhost:8080/help there's some online help that links the bracketed "see also" [[names]] in the docstrings to their documentation.

[1] http://arclanguage.org/item?id=809

-----

2 points by almkglor 6057 days ago | link

Another note: you can search through the docstrings by using (help "<string>"). Note that (help ...) differentiates by the quotes on the string. So

  (help string)
returns the docstring for the function 'string, while

  (help "string")
prints a list of functions whose docstrings contain "string".

-----

3 points by kennytilton 6058 days ago | link

Yes, because it is not a fixed target (still evolving) tho it sure would be nice to have. :)

fwiw, Here is another link: http://arcfn.com/foundation-doc.html

-----