Skip to content

doc: improve HalfFlat class docstring#8211

Merged
zaxtax merged 2 commits intopymc-devs:v6from
KRYSTALM7:doc/halfflat-docstrings-clean
Apr 15, 2026
Merged

doc: improve HalfFlat class docstring#8211
zaxtax merged 2 commits intopymc-devs:v6from
KRYSTALM7:doc/halfflat-docstrings-clean

Conversation

@KRYSTALM7
Copy link
Copy Markdown
Contributor

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.

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)

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (v6@0b6fc6a). Learn more about missing BASE report.

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##             v6    #8211   +/-   ##
=====================================
  Coverage      ?   91.71%           
=====================================
  Files         ?      124           
  Lines         ?    19962           
  Branches      ?        0           
=====================================
  Hits          ?    18309           
  Misses        ?     1653           
  Partials      ?        0           
Files with missing lines Coverage Δ
pymc/distributions/continuous.py 98.27% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@zaxtax zaxtax merged commit 506d728 into pymc-devs:v6 Apr 15, 2026
42 checks passed
@welcome
Copy link
Copy Markdown

welcome bot commented Apr 15, 2026

Congratulations Banner]
Congrats on merging your first pull request! 🎉 We here at PyMC are proud of you! 💖 Thank you so much for your contribution 🎁

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.

3 participants