Adopt Base's annotated types/functions as API #81
Conversation
|
This change has been discussed with other maintainers on Slack (the API shift, but not the exporting), so I'm inclined to merge this soon if I can figure out how to make doctests happy. |
tecosaur
force-pushed
the
api-adoption
branch
2 times, most recently
from
d1d62bc to
1beedda
Compare
|
This is held up by difficulty figuring out the Documenter side of things. |
|
It's hard to see how I can make this work before JuliaDocs/Documenter.jl#1781 is resolved 😬. Perhaps @mortenpi might have an idea? |
KristofferC
force-pushed
the
api-adoption
branch
from
1beedda to
769e49a
Compare
tecosaur
force-pushed
the
api-adoption
branch
3 times, most recently
from
8264fc8 to
0e3281a
Compare
|
In light of JuliaLang/julia#55845 and the change Kristoffer's just pushed it seems like neither of us can easily make Documenter do what we want here, so let's just leave the documentation of the Base-defined types there with an appropriate notice. I think all that needs to be done now is the |
This opens the door to shuffling parts currently implemented in Base into this stdlib without breaking any public APIs. It would be nice to actually show the relevant Annotated* docstrings, but unfortunately due to JuliaDocs/Documenter.jl#1781 it's a bit difficult to actually do so. We should re-visit this later.
tecosaur
force-pushed
the
api-adoption
branch
from
ba8ec41 to
d9d7472
Compare
|
I don't think there's anything else that needs changing? |
2 participants
This opens the door to shuffling parts currently implemented in Base into this stdlib without breaking any public APIs.
To try to help avoid people using
Base.Annot...anyway, I've exported these bindings. I think this is reasonable given unlike inBasethis library needs to be deliberately imported.