While debugging the failing test in #209, I needed to move some declarations around between header files. While doing that I was a little worried about breaking end-user code for anybody who touched these headers. I took care to avoid breaking user-code, but the whole exercise made me realize that there isn't any advantage to telling users about the different headers.
This PR proposes that we Deprecate usage of headers other than than grackle.h and grackle.def.
we may still want to expose other headers in the future (when we don't want to include the declaration directly inside grackle.h for one reason or another.
An example of this might be the proposed grackle_unstable.h header that provides functions with unstable API. The main purpose is to include debugging functions (which I don't think we should stabilize). But it may also be a way to add experimental features that we aren't ready to lock in yet.
While debugging the failing test in #209, I needed to move some declarations around between header files. While doing that I was a little worried about breaking end-user code for anybody who touched these headers. I took care to avoid breaking user-code, but the whole exercise made me realize that there isn't any advantage to telling users about the different headers.
This PR proposes that we Deprecate usage of headers other than than
grackle.handgrackle.def.grackle.hfor one reason or another.grackle_unstable.hheader that provides functions with unstable API. The main purpose is to include debugging functions (which I don't think we should stabilize). But it may also be a way to add experimental features that we aren't ready to lock in yet.