Skip to content

doc: improve HalfFlat class docstring#8211

Open
KRYSTALM7 wants to merge 1 commit intopymc-devs:v6from
KRYSTALM7:doc/halfflat-docstrings-clean
Open

doc: improve HalfFlat class docstring#8211
KRYSTALM7 wants to merge 1 commit intopymc-devs:v6from
KRYSTALM7:doc/halfflat-docstrings-clean

Conversation

@KRYSTALM7
Copy link
Copy Markdown

Improves the class-level docstring for the HalfFlat distribution in pymc/distributions/continuous.py.

Changes:

  • Expanded the one-line docstring into a full numpydoc-compliant docstring
  • Added extended summary describing the improper prior nature of the distribution
  • Added PDF formula using proportional notation
  • Added support and moments table (Mean and Variance are both undefined)
  • Added usage example
  • No Parameters section (distribution takes no parameters)

Related to #5459
Closes #8208

@welcome
Copy link
Copy Markdown

welcome bot commented Mar 22, 2026

Thank You Banner]
💖 Thanks for opening this pull request! 💖 The PyMC community really appreciates your time and effort to contribute to the project. Please make sure you have read our Contributing Guidelines and filled in our pull request template to the best of your ability.

@read-the-docs-community
Copy link
Copy Markdown

Copy link
Copy Markdown
Member

@OriolAbril OriolAbril left a comment

Choose a reason for hiding this comment

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

This is looking much better now, thanks!

If you haven't yet, you can check the preview at https://pymcio--8211.org.readthedocs.build/projects/docs/en/8211/api/distributions/generated/pymc.HalfFlat.html (from the readthedocs comment "Preview build" then browse to the respective page)

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.

2 participants