Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tag v1, write JOSS paper? #871

Open
dlfivefifty opened this issue Apr 1, 2023 · 1 comment
Open

Tag v1, write JOSS paper? #871

dlfivefifty opened this issue Apr 1, 2023 · 1 comment

Comments

@dlfivefifty
Copy link
Member

@jishnub I've started tagging v1 for a bunch of packages. ApproxFun hasn't had a breaking version in almost 2 years, maybe its time to tag v1.0?

We could also write a joint JOSS paper?

@jishnub
Copy link
Member

jishnub commented Apr 2, 2023

I think we can take this opportunity to formalize the exported functions. Currently, we have

@reexport using ApproxFunBase
@reexport using ApproxFunFourier
@reexport using ApproxFunOrthogonalPolynomials
@reexport using ApproxFunSingularities

which means that breaking changes to these sub-packages may become a breaking change in ApproxFun, even though the breakage might be an implementation detail that is inadvertently exposed to the user through the re-exports. I'll try to get this done over the next week. Once we have a concrete list of exported functions, we can certainly tag v1, as the top-level API is stable.

I'm also up for writing a JOSS paper, and it would be good to have a canonical reference describing the software that is complementary to the various references describing the math.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants