-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
DOC: Create documentation for logprob submodule #6477
Comments
I've created this issue after consulting the need for it with @ricardoV94 , I'll work on it as soon as possible. |
related to #5282 which also lists other functions missing from docs |
@ricardoV94, I'm not sure whether I should add the in-line docs or is there a way to add a page about logprob into the official PyMC docs? |
The functions/classes need to have docstrings following numpydoc and be listed in one of the files at https://github.com/pymc-devs/pymc/tree/main/docs/source/api |
More importantly, the logprob submodule itself should have a custom documentation page. @OriolAbril is there a good way to do this with markdown? Asking because all those files are |
most markdown it can be is something like: https://github.com/arviz-devs/arviz/blob/main/doc/source/api/plot_utils.md?plain=1 |
I got a bit caught up with other topics, so this one is free to take again |
Issue with current documentation:
Currently documentation doesn't cover the logprob submodule, write some starter doc using comments from #6465 and all information you have on the subject.
Idea or request for content:
-Why it's needed
-Main functionality
-Classes it contains
The text was updated successfully, but these errors were encountered: