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

DOC: Create documentation for logprob submodule #6477

Open
michaelraczycki opened this issue Jan 24, 2023 · 7 comments
Open

DOC: Create documentation for logprob submodule #6477

michaelraczycki opened this issue Jan 24, 2023 · 7 comments

Comments

@michaelraczycki
Copy link
Contributor

michaelraczycki commented Jan 24, 2023

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

@michaelraczycki
Copy link
Contributor Author

I've created this issue after consulting the need for it with @ricardoV94 , I'll work on it as soon as possible.

@ricardoV94 ricardoV94 changed the title DOC: Create documentation for logprob DOC: Create documentation for logprob submodule Jan 24, 2023
@OriolAbril
Copy link
Member

related to #5282 which also lists other functions missing from docs

@michaelraczycki
Copy link
Contributor Author

@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?

@OriolAbril
Copy link
Member

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

@ricardoV94
Copy link
Member

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 .rst

@OriolAbril
Copy link
Member

@michaelraczycki
Copy link
Contributor Author

I got a bit caught up with other topics, so this one is free to take again

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants