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: Numpydocs3 #5635

Merged
merged 2 commits into from
Dec 13, 2023
Merged

DOCS: Numpydocs3 #5635

merged 2 commits into from
Dec 13, 2023

Conversation

tkknight
Copy link
Contributor

@tkknight tkknight commented Dec 13, 2023

🚀 Pull Request

Description

Progressing numpydoc strings adoption, #4721.

Notes

ruff test output

No errors/warnings raised. Commands used:

ruff ../lib/iris/__init__.py
ruff ../lib/iris/_constraints.py
ruff ../lib/iris/analysis/__init__.py
ruff ../lib/iris/analysis/calculus.py
ruff ../lib/iris/aux_factory.py
ruff ../lib/iris/io/__init__.py

Links to current and new API docs

Note, some files are private so are not rendered in the docs.


Consult Iris pull request check list

Copy link

codecov bot commented Dec 13, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1e190b6) 89.69% compared to head (92af298) 89.69%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5635   +/-   ##
=======================================
  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.

@tkknight tkknight mentioned this pull request Dec 13, 2023
91 tasks
@tkknight tkknight changed the title ruff compliant and improved docstrings. DOCS: Numpydocs3 Dec 13, 2023
@bjlittle bjlittle self-assigned this Dec 13, 2023
@tkknight tkknight marked this pull request as ready for review December 13, 2023 16:53
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 Great 🚀

@bjlittle bjlittle merged commit 1430c3d into SciTools:main Dec 13, 2023
17 checks passed
@tkknight tkknight deleted the numpydocs3 branch December 13, 2023 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants