search

EPOC-NZ / JADE.jl

Other
9 stars 2 forks source link

Identify public API surface #10

Closed odow closed 1 year ago

odow commented 1 year ago

We currently export some functions

https://github.com/EPOC-NZ/JADE.jl/blob/b705880bfb472cb433c385b95d23f782404ded07/src/JADE.jl#L37-L46

the docs list a bunch more

https://github.com/EPOC-NZ/JADE.jl/blob/main/docs/src/api.md

We should clarify what is and what isn't public API, and then tidy up the naming conventions so that we don't have snake_case almost everywhere, but then have gettimeseries or the horrific getinflows_for_historical.

odow commented 1 year ago

Talked to @adow031. The conclusion is that we're somewhat free to declare a private API and break that. However, we shouldn't change or break the API used in the runJADE.jl file that users will be running publicly.