gorillascript icon indicating copy to clipboard operation
gorillascript copied to clipboard

Document public AST API for macros

Open andreyvit opened this issue 12 years ago • 3 comments

I understand that we're in 0.x stage, but would be nice to get at least a rough idea of which AST methods/props are going to become the public API is the future (i.e.: are safe to use inside the macros).

andreyvit avatar Jul 07 '13 19:07 andreyvit

As of 0.9.x, the macro API is mostly stable. I do need to document all the methods and such, though.

I also want to add support for async macros and such before I deem it fully stable (at which point I'd be getting close to a 1.0 release)

ckknight avatar Jul 07 '13 23:07 ckknight

So you mean all that stuff accessed from the prelude is going to become a public API after 1.0? With a commitment to backward compatibility?

andreyvit avatar Jul 08 '13 00:07 andreyvit

You are correct.

There are a few minor naming things I want to change (e.g. cacheable to is-cacheable), and adding more documentation to each part involved, but other than that, it will be stable.

ckknight avatar Jul 08 '13 03:07 ckknight