Skip to content

doc(gh-2107): Improved documentation for Negative Binomial distributions#2109

Merged
juanitorduz merged 7 commits intopyro-ppl:masterfrom
Qazalbash:doc-neg-binomial
Dec 22, 2025
Merged

doc(gh-2107): Improved documentation for Negative Binomial distributions#2109
juanitorduz merged 7 commits intopyro-ppl:masterfrom
Qazalbash:doc-neg-binomial

Conversation

@Qazalbash
Copy link
Collaborator

This PR attempts to address the request for improving documentation for Negative Binomial distributions in #2107.

Fixes #2107.

Copy link
Member

@fehiepsi fehiepsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks @Qazalbash!

@juanitorduz
Copy link
Collaborator

It seems the build docs is failing,

The job failed because of Sphinx docstring formatting errors in numpyro/distributions/truncated.py, specifically in the docstringThe failure in your CI pipeline is due to errors in the formatting of docstrings within the Python file of validate_sample..wrapper. The errors include "Unexpected indentation" and "Literal block ends without a blank line; unexpected unindent." These errors are numpyro/distributions/truncated.py. The logs indicate specific indentation issues flagged by the doc treated asutils package while processing Sphinx documentation:

build failures1. Lines in the decorator @Docstring of numpyro.distributions.util.validate_sample..wrapper:

Line 4: Unexpected indentation because warnings are treated as errors in your docs build.

Can you try make docs if you can reproduce (and fix?) locally?

@Qazalbash
Copy link
Collaborator Author

Can you try make docs if you can reproduce (and fix?) locally?

I will try.

`numpyro.distributions.truncated.DoublyTruncatedPowerLaw.log_prob`
@juanitorduz
Copy link
Collaborator

Thanks @Qazalbash !

@juanitorduz juanitorduz merged commit 3c2c76b into pyro-ppl:master Dec 22, 2025
9 checks passed
@Qazalbash Qazalbash deleted the doc-neg-binomial branch December 22, 2025 17:43
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

Successfully merging this pull request may close these issues.

Improved documentation for Negative Binomial distributions

3 participants