Arc Forumnew | comments | leaders | submit | dmdavis's commentslogin
2 points by dmdavis 6126 days ago | link | parent | on: List of Arc Functions and Macros

I added search capabilities. Just type a query in the text box, press enter, and it will return all functions/macros/xdefs that contain that string.

-----

1 point by dmdavis 6128 days ago | link | parent | on: List of Arc Functions and Macros

I changed my script that grabs the functions so that it will work with docstrings, but I thought it made more sense to be documenting the main branch rather than the git repo. What do you think?

-----

1 point by nex3 6127 days ago | link

The Git repo is pretty much a superset of arc0, except for a few bugfixes here and there. Plus if we're going to actually add docstrings to the code, the only way to do that would be to commit them to the repo.

I think it would make the most sense to just document the Git repo and make a note in the documentation that it's not identical to arc0.

-----

1 point by dmdavis 6127 days ago | link

Yeah, that makes sense. The page is now showing all info from the Git repo.

-----

1 point by dmdavis 6128 days ago | link | parent | on: List of Arc Functions and Macros

OK, I've made a few changes, let me know what you think.

  *I put everything into one tree, with a node for each file
  *I alphabetized everything, except arc.arc is the first file listed.
  *I added the xdefs from ac.scm
  *I added a button to expand all the tree (except the source code) so that it's easier to search

-----

1 point by dmdavis 6129 days ago | link | parent | on: List of Arc Functions and Macros

I'm not sure yet. I wrote a script that generates all the code from the .arc files, so it would be tricky to throw the docs in there. What may be best would be to use the docstrings that someone has added once they become part of the main release, and I'll change my script to grab those?

-----

1 point by ryantmulligan 6129 days ago | link

I think the best way would be to use that docstrings patch and then just pull the docstrings.

-----

3 points by dmdavis 6129 days ago | link | parent | on: List of Arc Functions and Macros

thanks, I'll look at adding those.

-----

1 point by dmdavis 6128 days ago | link

OK, done.

-----

1 point by dmdavis 6129 days ago | link | parent | on: List of Arc Functions and Macros

OK, I've added the defs and macs for *.arc. Any thoughts on a better way to present this info?

-----

1 point by dmdavis 6129 days ago | link | parent | on: List of Arc Functions and Macros

I was going to alphabetize, but then I thought that it might be good to see them in the order they are defined in the file. I'll have to make an option to sort them.

-----

3 points by greatness 6129 days ago | link

Different styles of organization would be nice:

* Category (input/output, list functions, etc.)

* Function or Macro (Split them up and alphabetize them)

* Alphabetical (all in one giant alphabetical list.)

* By file (arc.arc, app.arc, etc.)

You're already doing a combination of two of these, but you should give them as separate options; or perhaps keep what you have and just add all these options. Shouldn't be that hard if you keep all the definitions in a database, with the information required to do this.

-----