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

Mark public API with public keyword #228

Open
mofeing opened this issue Nov 2, 2024 · 0 comments · May be fixed by #269
Open

Mark public API with public keyword #228

mofeing opened this issue Nov 2, 2024 · 0 comments · May be fixed by #269
Labels
documentation Improvements or additions to documentation refactor Change internals triage Needs group consensus
Milestone

Comments

@mofeing
Copy link
Member

mofeing commented Nov 2, 2024

Now that API stabilization is coming closer and closer and users are starting to run with some problems on what should be used or not, we should start marking public API with the new public keyword which landed in Julia 1.11.

https://docs.julialang.org/en/v1/base/base/#public

  • Exported symbols are automatically public
  • There are some symbols which we want them to be public (i.e. users should not be afraid of using them) but not export them automatically (i.e. you need to access by explicit import or Tenet.whatever access). Those are the ones we must mark them as public.

Compat.jl provides the @public macro which acts as a no-op in Julia 1.10

@mofeing mofeing added documentation Improvements or additions to documentation refactor Change internals triage Needs group consensus labels Nov 2, 2024
@mofeing mofeing added this to the 0.8 milestone Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation refactor Change internals triage Needs group consensus
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant