Declare semver API via the public keyword

[felixcremer]

I think it would be good to declare the API of DimensionalData via the public keyword.

One example that I would expect to be API but is not exported is format because it is described in the extension docs.

If we want to use the public keyword in older Julia versions we can use the following:

VERSION >= v"1.11.0-DEV.469" && eval(Meta.parse("public a, b, c"))

according to the julia docs https://docs.julialang.org/en/v1/manual/modules/#Export-lists

Having done this would enable us to write docstrings for the internal functions and ditch this heuristic of everything that is documented is part of the API if not stated otherwise.

[rafaqz]

Public keywirds sounds good.

But can it go in a static conditional block rather than Meta.parse? thats hard to read

[asinghvi17]

No, that breaks the parser. https://github.com/SciML/SciMLPublic.jl could be fine to use though.

[rafaqz]

Uggh thats so ugly. But lets use Public.jl, no need to use SciMLPublic.jl

[asinghvi17]

I'm pretty sure that is Public.jl :D

[tiemvanderdeure]

There is also https://github.com/JuliaLang/Public.jl but it's not released

[rafaqz]

Thats just weird tho

Its literally the same package

(They turned down registering in favor of the ugly Meta.parse 😭)

[felixcremer]

I think another alternative would be to use Compat.jl this is currently not in the Manifest of DimensionalData but maybe it would not too bad to add it.