Arc Forum | Arc Docs

Arc Forum

14 points by dmdavis 6160 days ago | 4 comments

I've updated my Arc Docs website for the new version of Arc. I also made a separate page for the Git repo. All the functions and macros are listed on the left of the page, and there's a search box on the right, which will search for any function, macro, or xdex that contains the search term.

Oh, and when I say documentation, I mean the source code. The git repo will automatically pull any docstrings that are added, but that's it.

arc1 - http://dyn.dnadavis.net/ArcDocs/

arc Git repository - http://dyn.dnadavis.net/ArcGitDocs/

I'm making the Git repo docs automatically update to the latest revision in Git every night. Let me know if that causes any problems.

4 points by almkglor 6159 days ago | link

I've made [[x]] in docstrings refer to other functions, like so:

  (def queue ()
    " Creates a queue.
      See also [[enq]] [[deq]] [[qlen]] [[qlist]] [[enq-limit]]"
    (list nil nil 0))

This convention is used by the /help operation I built into prompt.arc, and causes [[enq]] to link to the docstring for 'enq. I think it might be useful to support this.

-----

4 points by almkglor 6159 days ago | link

Oh BTW bug report - whenever I click on +/- on opera 9.10 windows, it scrolls back to the top. Older versions scrolled to random points in the page.

-----

2 points by maxwell 6159 days ago | link

I'm getting the same thing on OS X Firefox 2.0.0.12.

-----

1 point by NickSmith 6160 days ago | link

Once again, this is really useful. Thank you. :)

-----