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

DOCS: Enabled all pydocstyle (numpy) ruff rules with a list of specific exceptions. #5636

Merged
merged 11 commits into from
Dec 15, 2023

Conversation

tkknight
Copy link
Contributor

🚀 Pull Request

Description

Enabled all pydocstyle (numpy) ruff rules with a list of specific exceptions.

The temporary rules can be reviewed and either removed (then not ignored) or could be promoted to a permanent rule - which we want to minimize where possible.

Running ruff will still complete without warnings or errors for now.

$ ruff ../lib/iris


Consult Iris pull request check list

@tkknight tkknight changed the title Enabled all pydocstyle (numpy) ruff rules with a list of specific exceptions. DOCS: Enabled all pydocstyle (numpy) ruff rules with a list of specific exceptions. Dec 13, 2023
Copy link

codecov bot commented Dec 13, 2023

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (1430c3d) 89.69% compared to head (4cbe0f4) 89.69%.
Report is 2 commits behind head on main.

❗ Current head 4cbe0f4 differs from pull request most recent head da7d7bc. Consider uploading reports for the commit da7d7bc to get more accurate results

Files Patch % Lines
lib/iris/experimental/animate.py 0.00% 1 Missing ⚠️
lib/iris/experimental/raster.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5636   +/-   ##
=======================================
  Coverage   89.69%   89.69%           
=======================================
  Files          90       90           
  Lines       22807    22807           
  Branches     5441     5441           
=======================================
  Hits        20456    20456           
  Misses       1618     1618           
  Partials      733      733           

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

Copy link
Member

@bjlittle bjlittle left a comment

Choose a reason for hiding this comment

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

@tkknight This looks good, thanks!

We can iterate on this and slowly move forwards 👍

@bjlittle bjlittle merged commit d0ee9c2 into SciTools:main Dec 15, 2023
16 checks passed
@tkknight tkknight deleted the ruff_docstrings branch December 17, 2023 12:34
@tkknight tkknight mentioned this pull request Dec 17, 2023
13 tasks
Comment on lines 128 to +133
... warnings.filterwarnings("ignore", module="iris.coord_systems", lineno=449)
... my_operation()
...
iris/coord_systems.py:800: IrisDefaultingWarning: Discarding false_easting and false_northing that are not used by Cartopy.
iris/coord_systems.py:434: IrisUserWarning: Setting inverse_flattening does not affect other properties of the GeogCS object. To change other properties set them explicitly or create a new GeogCS instance.
warnings.warn(wmsg, category=iris.exceptions.IrisUserWarning)
iris/coord_systems.py:772: IrisDefaultingWarning: Discarding false_easting and false_northing that are not used by Cartopy.
Copy link
Contributor

Choose a reason for hiding this comment

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

Oops! Only just spotted this. The change should have instead been to update lineno= to correctly target the IrisUserWarning. #5736

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.

None yet

3 participants