Skip to content
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

Add PyDocStyle Support #951

Merged
merged 17 commits into from
Aug 22, 2024
Merged

Add PyDocStyle Support #951

merged 17 commits into from
Aug 22, 2024

Conversation

juanitorduz
Copy link
Collaborator

@juanitorduz juanitorduz commented Aug 20, 2024

Give some love to our docstrings to ensure they are of the quality we want. https://docs.astral.sh/ruff/rules/#pydocstyle-d can help us with that!

290 Errors to fix 💪

This PR does not change any code, just doc-strings.


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

@juanitorduz juanitorduz changed the title Add comments fix init Add PyDocStyle Support Aug 20, 2024
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@juanitorduz juanitorduz marked this pull request as draft August 20, 2024 20:31
@juanitorduz
Copy link
Collaborator Author

ok just 100 more errors to go!

@juanitorduz juanitorduz self-assigned this Aug 21, 2024
@juanitorduz juanitorduz added docs Improvements or additions to documentation enhancement New feature or request labels Aug 21, 2024
Copy link

codecov bot commented Aug 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.68%. Comparing base (f6c6825) to head (88961ce).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #951   +/-   ##
=======================================
  Coverage   95.68%   95.68%           
=======================================
  Files          35       35           
  Lines        3526     3526           
=======================================
  Hits         3374     3374           
  Misses        152      152           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@juanitorduz juanitorduz marked this pull request as ready for review August 21, 2024 09:25
Copy link
Contributor

@wd60622 wd60622 left a comment

Choose a reason for hiding this comment

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

Good stuff. Thanks for this!
Just a small suggestion and comment

pymc_marketing/mmm/base.py Outdated Show resolved Hide resolved
pymc_marketing/mmm/delayed_saturated_mmm.py Outdated Show resolved Hide resolved
@juanitorduz juanitorduz merged commit 39d38b7 into main Aug 22, 2024
13 checks passed
@juanitorduz juanitorduz deleted the pydocstyle branch August 22, 2024 13:27
radiokosmos pushed a commit to radiokosmos/pymc-marketing that referenced this pull request Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants