Add Docstrings for pymc.dims.distributions.scalar by MSK-005 · Pull Request #8041 · pymc-devs/pymc

MSK-005 · 2026-01-05T21:29:40Z

Description

This PR (for #7861) adds a function create_scalar_dims_docstrings() that copies the docstrings from all relevant classes in pymc.distributions.continuous to pymc.dims.distributions.scalar, replacing "tensor_like" with "xtensor_like" where applicable.

Related Issue

Closes #7861
Related to #

Checklist

Checked that the pre-commit linting/style checks pass
Included tests that prove the fix is effective or that the new feature works
Added necessary documentation (docstrings and/or example notebooks)
If you are a pro: each commit corresponds to a relevant logical change

Type of change

MSK-005 · 2026-01-08T17:23:47Z

@ricardoV94, looking forward to your code review.

ricardoV94 · 2026-01-13T17:12:01Z

+    # Get all subclasses of Continuous class
+    imported_dists = {
+        name: cls
+        for name, cls in inspect.getmembers(_regular_dists, inspect.isclass)
+        if issubclass(cls, Continuous) and cls is not Continuous
+    }


Small performance idea: I guess we can get dims_dists first and do a more targetted filter (matches name -> is a subclass of Distribution)?

ricardoV94 · 2026-01-13T17:13:10Z

Seems to work for the docs: https://pymcio--8041.org.readthedocs.build/projects/docs/en/8041/api/dims/generated/pymc.dims.HalfCauchy.html

ricardoV94 · 2026-01-17T14:45:07Z

        return super().dist([alpha, beta], **kwargs)
+
+
+def create_scalar_dims_docstrings():


Sorry to rethink again.

What if instead we use a decorator on the specific classes or manually do Univariate.__doc__ = foo(regular_dists.Univariate.__doc__)? So we don't need to loop and try to guess what goes with what. This also avoids accidentally overriding custom docstrings if we add them in the future.

Went forward with the decorator approach. Also, pm.dims.Univariate.dist has no documentation. What do we do about that?

The dist method having no documentation? It's fine? They don't have in regular distributions either if I recall correctly

Here's the dist() page for pm.Normal.dist: link

Here's the dist() page for pm.dims.Normal.dist: link

I think it's just showing the docstrings of the base class, nothing specific about the Normal dist

ricardoV94 · 2026-01-20T11:08:29Z

 from pymc.distributions.continuous import HalfCauchyRV, HalfStudentTRV, flat, halfflat


+def _copy_docstring(regular_cls):


Makes more sense to have this helper in pymc/dims/distributions/core.py?

Done. And I added a change_doc parameter that will replace "tensor_like" with "xtensor_like". The purpose was to provide flexibility if you want to modify docstrings before you copy them.

ricardoV94 · 2026-01-21T21:49:19Z

+def _change_docstring_words(docstring):
+    return docstring.replace("tensor_like", "xtensor_like")


still think it should be in core.py. Also let's leave the argument flexibility for when we actually need it (which may be never). It's an internal function so we don't need to worry about changing API

Done. Sorry about that.

There's nothing to apologize about

ricardoV94 · 2026-01-21T22:19:11Z

This is pretty sweet, thanks @MSK-005

codecov · 2026-01-21T22:29:00Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.81%. Comparing base (056e80c) to head (ba0d897).
⚠️ Report is 67 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8041      +/-   ##
==========================================
- Coverage   91.44%   90.81%   -0.64%     
==========================================
  Files         116      121       +5     
  Lines       19002    19447     +445     
==========================================
+ Hits        17377    17660     +283     
- Misses       1625     1787     +162

Files with missing lines	Coverage Δ
pymc/dims/distributions/core.py	`90.00% <100.00%> (+0.44%)`	⬆️
pymc/dims/distributions/scalar.py	`95.62% <100.00%> (+0.74%)`	⬆️

... and 23 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

MSK-005 · 2026-01-21T22:51:55Z

@ricardoV94, thank you for your guidance. Truly a blessing. All tests pass. Also a blessing.
Will appear in more PRs, hopefully.

OriolAbril

Looks great!

Two nits which can perfectly be tackled in a future PR would be adding xtensor_like to the glossary like tensor_like and to the type aliases.

Sources for these two things: https://github.com/pymc-devs/pymc/blob/main/docs/source/glossary.md and variable numpydoc_xref_aliases of https://github.com/pymc-devs/pymc/blob/main/docs/source/conf.py#L63

welcome · 2026-01-22T16:43:54Z

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

MSK-005 changed the title ~~Added function to copy docstrings~~ Add Docstrings for pymc.dims.distributions.scalar Jan 5, 2026

MSK-005 mentioned this pull request Jan 6, 2026

Create automatic docstrings for dims module from original distributions #7861

Open

ricardoV94 reviewed Jan 13, 2026

View reviewed changes

ricardoV94 requested a review from OriolAbril January 13, 2026 17:12

ricardoV94 added docs dims labels Jan 13, 2026

MSK-005 force-pushed the docstrings/7861 branch from 524a95c to 1958aaa Compare January 15, 2026 22:49

MSK-005 added 2 commits January 16, 2026 03:52

Added function to copy docstrings

610eebf

Improved searching mechanism for matching regular dists

f480347

MSK-005 force-pushed the docstrings/7861 branch from 1958aaa to f480347 Compare January 15, 2026 22:53

ricardoV94 reviewed Jan 17, 2026

View reviewed changes

Shift to decorator approach

fa417d9

ricardoV94 reviewed Jan 20, 2026

View reviewed changes

Moved decorator to pymc/dims/distributions/core.py

4074c8b

ricardoV94 reviewed Jan 21, 2026

View reviewed changes

Remove change_doc parameter

ba0d897

ricardoV94 approved these changes Jan 21, 2026

View reviewed changes

OriolAbril approved these changes Jan 22, 2026

View reviewed changes

ricardoV94 merged commit c2476b8 into pymc-devs:main Jan 22, 2026
42 checks passed

MSK-005 deleted the docstrings/7861 branch January 22, 2026 18:30

		return super().dist([alpha, beta], **kwargs)


		def create_scalar_dims_docstrings():

		from pymc.distributions.continuous import HalfCauchyRV, HalfStudentTRV, flat, halfflat


		def _copy_docstring(regular_cls):

		def _change_docstring_words(docstring):
		return docstring.replace("tensor_like", "xtensor_like")

Conversation

MSK-005 commented Jan 5, 2026

Description

Related Issue

Checklist

Type of change

Uh oh!

MSK-005 commented Jan 8, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ricardoV94 commented Jan 13, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ricardoV94 commented Jan 21, 2026

Uh oh!

codecov Bot commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

MSK-005 commented Jan 21, 2026

Uh oh!

OriolAbril left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

welcome Bot commented Jan 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov Bot commented Jan 21, 2026 •

edited

Loading