Skip to content

Support public interface for non-exported #143

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Sep 23, 2025
Merged

Support public interface for non-exported #143

merged 6 commits into from
Sep 23, 2025
+150 −34

Conversation

Tokazama
Copy link
Collaborator

Where public is available there is now a warning when using non-exported things when looking at docs. This PR helps clear that up for relevant versions of Julia.

@Tokazama
Support public interface for non-exported
922454b
@Tokazama
Remove unecessary public static_promote
f8d8706
@Tokazama
Add + doc static_first, static_step, static_last to exports
14e531e 
These methods are used in downstream packages and
are useful for reconstructing static indices.
They now have docs and are exported to be officially
made part of the public API.
@ChrisRackauckas
Copy link
Member

Use SciMLPublic.jl for backwards compat

@Tokazama
Use SciMLPublic.jl
274833f
@Tokazama
Fixed formatting and minor version bump
ccd7b31
@Tokazama
Fix docs, particularly to reflect their public scoping
e65f29d 
For  unexported public methods, this adds `Static.<name>` to the docs.
Some of these docs weren't fully implemented, requiring some new
doc strings. This also fixed some of the consistency between docs.
@Tokazama
Copy link
Collaborator Author

@chriselrod , are there any methods here you don't want public?

@chriselrod
Copy link
Collaborator

@chriselrod , are there any methods here you don't want public?

I'm no longer a stakeholder in this.
But I'd probably not want any methods used for implementing functionality to be public, like _promote_shape. I'd probably follow the heuristic of leading underscore -> internal.

@Tokazama
Copy link
Collaborator Author

@chriselrod , are there any methods here you don't want public?

I'm no longer a stakeholder in this. But I'd probably not want any methods used for implementing functionality to be public, like _promote_shape. I'd probably follow the heuristic of leading underscore -> internal.

Sounds good. I'm only annotating methods as public that are used in several packages down stream already and adding more docs.

@Tokazama Tokazama merged commit 418c08d into master Sep 23, 2025
33 of 35 checks passed
@Tokazama Tokazama deleted the public branch September 23, 2025 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Tokazama @ChrisRackauckas @chriselrod