pymc
pymc copied to clipboard
Fix shape_utils missing functions and misformatted returns
What is this PR about? Fixes #7004 The shape_utils module was missing functions in the documentation. Additionally, the rendering of returns for certain functions was identified as messy. The focus of this PR is to include type hints in the docstring, in line with the suggested improvement.
Checklist
- [x] Explain important implementation details π
- [x] Make sure that the pre-commit linting/style checks pass.
- [x] Link relevant issues (preferably in nice commit messages)
- [x] Are the changes covered by tests and docstrings?
- [x] Fill out the short summary sections π
Documentation
- Added shape_utils missing functions to documentation
- Improved return formatting for the affected functions to enhance readability.
- Included type hints in the docstring for better display in the documentation.
:books: Documentation preview :books:: https://pymc--7006.org.readthedocs.build/en/7006/
:sparkling_heart: Thanks for opening this pull request! :sparkling_heart: 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.
Codecov Report
Merging #7006 (464ac0a) into main (ec24ce6) will decrease coverage by
0.06%. Report is 1 commits behind head on main. The diff coverage is100.00%.
Additional details and impacted files
@@ Coverage Diff @@
## main #7006 +/- ##
==========================================
- Coverage 92.19% 92.13% -0.06%
==========================================
Files 101 101
Lines 16921 16921
==========================================
- Hits 15600 15590 -10
- Misses 1321 1331 +10
| Files | Coverage Ξ | |
|---|---|---|
| pymc/distributions/shape_utils.py | 94.94% <100.00%> (ΓΈ) |
Hi @ricardoV94 , I tried to sovle this pre-commit Failure. But unable to fix this. Please guide me.
/pre-commit-run
Hi @twiecki the pre-commit issue is still unresolved. What else can i do on this PR.
@UditNayak You need to run pre-commit locally.