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

ruff compliance for D205. #5681

Merged
merged 26 commits into from
Jan 12, 2024
Merged

ruff compliance for D205. #5681

merged 26 commits into from
Jan 12, 2024

Conversation

tkknight
Copy link
Contributor

@tkknight tkknight commented Jan 8, 2024

🚀 Pull Request

Description

PR solely for fixing D205: 1 blank line required between summary line and description

Continues work of #5625.


Consult Iris pull request check list

Copy link

codecov bot commented Jan 8, 2024

Codecov Report

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

Comparison is base (1e2a85a) 89.69% compared to head (5af2c97) 89.69%.

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

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

@tkknight tkknight mentioned this pull request Jan 8, 2024
13 tasks
@tkknight tkknight marked this pull request as ready for review January 8, 2024 17:14
@tkknight tkknight requested a review from bjlittle January 9, 2024 14:03
@bjlittle bjlittle requested review from bjlittle and removed request for bjlittle January 10, 2024 10:43
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 Gosh. This was hard.

You've make an incredible effort to reformat the docstrings.

I've tried my best to complement your efforts to formulate an appropriate single line summary for each docstring. We don't need perfection here, as we can iterate over time and massage the content.

A bunch of suggestions which you can accept or not.

Either way, a huge effort and a decent step forwards 💯 👍

lib/iris/_data_manager.py Outdated Show resolved Hide resolved
lib/iris/_lazy_data.py Outdated Show resolved Hide resolved
lib/iris/_merge.py Outdated Show resolved Hide resolved
lib/iris/_representation/cube_printout.py Outdated Show resolved Hide resolved
lib/iris/_representation/cube_printout.py Outdated Show resolved Hide resolved
lib/iris/coords.py Outdated Show resolved Hide resolved
lib/iris/coords.py Outdated Show resolved Hide resolved
lib/iris/coords.py Outdated Show resolved Hide resolved
lib/iris/coords.py Outdated Show resolved Hide resolved
lib/iris/experimental/ugrid/mesh.py Outdated Show resolved Hide resolved
@tkknight
Copy link
Contributor Author

All review comments accepted - one at a time until I reliased there was a batch option!

One additional commit from my final read thru, minor layout and spotted some duplicate text. See d168d07.

Think this is now ready.

@bjlittle bjlittle merged commit d95c9e2 into SciTools:main Jan 12, 2024
17 checks passed
tkknight added a commit to tkknight/iris that referenced this pull request Jan 15, 2024
* upstream/main:
  ruff compliance for D205. (SciTools#5681)
  Added whatsnew to warnings PR (SciTools#5696)
  Removed use of catch_warnings (SciTools#5685)
  Better documentation for Cube names in curl (SciTools#5680)
  fix typo (SciTools#5689)
  Make further topics obviously different (SciTools#5684)
  [pre-commit.ci] pre-commit autoupdate (SciTools#5682)
tkknight added a commit to tkknight/iris that referenced this pull request Jan 15, 2024
* upstream/main:
  ruff compliance for D205. (SciTools#5681)
  Added whatsnew to warnings PR (SciTools#5696)
  Removed use of catch_warnings (SciTools#5685)
  Better documentation for Cube names in curl (SciTools#5680)
  fix typo (SciTools#5689)
tkknight added a commit to tkknight/iris that referenced this pull request Jan 15, 2024
* upstream/main:
  ruff compliance for D205. (SciTools#5681)
  Added whatsnew to warnings PR (SciTools#5696)
  Removed use of catch_warnings (SciTools#5685)
  Better documentation for Cube names in curl (SciTools#5680)
tkknight added a commit to tkknight/iris that referenced this pull request Jan 24, 2024
* upstream/main: (26 commits)
  Bump scitools/workflows from 2023.12.1 to 2024.01.0 (SciTools#5710)
  Faster trivial equality checks for coordinates and arrays (SciTools#5691)
  Make the Coord.cell method lazy (SciTools#5693)
  Re-write `pearsonr` to use `Resolve` (SciTools#5638)
  ruff compliance for D401. (SciTools#5687)
  Bump actions/cache from 3 to 4 (SciTools#5703)
  update rtd ubuntu and mambaforge (SciTools#5702)
  [pre-commit.ci] pre-commit autoupdate (SciTools#5699)
  ruff compliance for D205. (SciTools#5681)
  Added whatsnew to warnings PR (SciTools#5696)
  Removed use of catch_warnings (SciTools#5685)
  Better documentation for Cube names in curl (SciTools#5680)
  fix typo (SciTools#5689)
  Make further topics obviously different (SciTools#5684)
  [pre-commit.ci] pre-commit autoupdate (SciTools#5682)
  ruff complliance for D100. (SciTools#5678)
  move tests.pp to tests.__init__ (SciTools#5679)
  ruff compliance for D417, D106 (SciTools#5677)
  ruff compliance for D200. (SciTools#5675)
  ruff compliance for D106. (SciTools#5676)
  ...
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.

2 participants