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

Documentation for gradlogpdf #1844

Open
cgarling opened this issue Apr 1, 2024 · 1 comment
Open

Documentation for gradlogpdf #1844

cgarling opened this issue Apr 1, 2024 · 1 comment

Comments

@cgarling
Copy link

cgarling commented Apr 1, 2024

Thanks for your work maintaining this package. Quick question: I see that gradlogpdf is tested in test/gradlogpdf.jl but I do not see the method in the documentation. Is gradlogpdf considered part of the public API? If so, it should have a docstring right?

@mschauer
Copy link
Member

mschauer commented Apr 1, 2024

First of all, withholding docstrings for functions that are not part of the public API is bad policy, also non-trivial internal functions need documentation in form of docstrings. Second, gradlogpdf is widely adopted, so we cannot make breaking changes to it without consideration, https://juliahub.com/ui/Search?q=gradlogpdf&type=code

Adding a docstring is a good idea.

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