Skip to content

Fix shape_utils missing functions and misformatted returns #7006

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

UditNayak
Copy link

@UditNayak UditNayak commented Nov 10, 2023

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

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.

image


📚 Documentation preview 📚: https://pymc--7006.org.readthedocs.build/en/7006/

Copy link

welcome bot commented Nov 10, 2023

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

codecov bot commented Nov 11, 2023

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 is 100.00%.

Additional details and impacted files

Impacted file tree graph

@@            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%> (ø)

... and 2 files with indirect coverage changes

@UditNayak
Copy link
Author

Hi @ricardoV94 , I tried to sovle this pre-commit Failure. But unable to fix this. Please guide me.

@twiecki
Copy link
Member

twiecki commented Nov 18, 2023

/pre-commit-run

@UditNayak
Copy link
Author

Hi @twiecki the pre-commit issue is still unresolved. What else can i do on this PR.

@twiecki
Copy link
Member

twiecki commented Nov 28, 2023

@UditNayak You need to run pre-commit locally.

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.

DOC: shape_utils missing functions and misformatted returns
3 participants