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

exporting public API #127

Closed
GuusAvis opened this issue Jun 7, 2024 · 2 comments
Closed

exporting public API #127

GuusAvis opened this issue Jun 7, 2024 · 2 comments

Comments

@GuusAvis
Copy link

GuusAvis commented Jun 7, 2024

Hello!

I noticed that there are a couple of functions that are listed in the Public API documentation but that are not exported by StochasticAD.jl. Moreover, I think it would be useful if they were exported. These functions are

  • value;
  • delta.

Perhaps there is a good reason for not exporting them, but in case this is an oversight perhaps they can be added to the exports. Thanks!

@gaurav-arya
Copy link
Owner

Hi! Thanks for making the issue. In general, I think there's a practice in Julia to only export symbols that are unlikely to clash with other packages. I felt like value and delta were too generic to export, but they are indeed still public API. (On the other hand, there may be more specific identifiers that are not exported due to my oversight; feel free to open a new issue if you spot any of these.)

Julia 1.11 is going to get a public keyword to use in exactly this situation: once that's available, I'll definitely mark value and delta as public!

@GuusAvis
Copy link
Author

That makes sense, thanks!

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

No branches or pull requests

2 participants