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

Adopt Base's annotated types/functions as API #81

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tecosaur
Copy link
Collaborator

@tecosaur tecosaur commented Aug 11, 2024

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 in Base this library needs to be deliberately imported.

@tecosaur
Copy link
Collaborator Author

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.

Copy link
Member

@topolarity topolarity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks @tecosaur

@tecosaur tecosaur force-pushed the api-adoption branch 2 times, most recently from d1d62bc to 1beedda Compare August 23, 2024 15:15
@tecosaur
Copy link
Collaborator Author

tecosaur commented Sep 4, 2024

This is held up by difficulty figuring out the Documenter side of things.

@tecosaur
Copy link
Collaborator Author

It's hard to see how I can make this work before JuliaDocs/Documenter.jl#1781 is resolved 😬.

Perhaps @mortenpi might have an idea?

This opens the door to shuffling parts currently implemented in Base
into this stdlib without breaking any public APIs.
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

Successfully merging this pull request may close these issues.

2 participants