search

mozilla / mozanalysis

A library for Mozilla experiments analysis
https://mozilla.github.io/mozanalysis/
Mozilla Public License 2.0
9 stars 13 forks source link

Formatting changes to enable more Ruff Rules #214

Closed jaredsnyder closed 4 months ago

jaredsnyder commented 5 months ago

fixes #213

jaredsnyder commented 5 months ago

Ruff does not yet support Sphinx-style docstrings :upside_down_face: https://github.com/astral-sh/ruff/issues/6606

jaredsnyder commented 5 months ago

Removed the docstring check because sphinx isn't yet supported. Left the updates though because when sphinx is supported it'll be less work to modify them than to do it over again

codecov-commenter commented 5 months ago

Codecov Report

Attention: Patch coverage is 77.02703% with 17 lines in your changes are missing coverage. Please review.

Project coverage is 78.84%. Comparing base (2722331) to head (a3bd6db).

Files Patch % Lines
src/mozanalysis/experiment.py 63.63% 8 Missing :warning:
src/mozanalysis/sizing.py 78.57% 3 Missing :warning:
src/mozanalysis/frequentist_stats/sample_size.py 80.00% 2 Missing :warning:
src/mozanalysis/bayesian_stats/binary.py 0.00% 1 Missing :warning:
src/mozanalysis/bq.py 0.00% 1 Missing :warning:
src/mozanalysis/frequentist_stats/bootstrap.py 50.00% 1 Missing :warning:
src/mozanalysis/metrics/__init__.py 88.88% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #214 +/- ## ========================================== - Coverage 79.38% 78.84% -0.54% ========================================== Files 23 23 Lines 1033 1035 +2 ========================================== - Hits 820 816 -4 - Misses 213 219 +6 ``` | [Flag](https://app.codecov.io/gh/mozilla/mozanalysis/pull/214/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mozilla) | Coverage Δ | | |---|---|---| | [project](https://app.codecov.io/gh/mozilla/mozanalysis/pull/214/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mozilla) | `78.84% <77.02%> (-0.54%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mozilla#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

jaredsnyder commented 5 months ago

reverted the docstring stuff because sphinx doesn't like it :(