Skip to content

added classification enums to qp #6346

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Feb 28, 2025
Merged

added classification enums to qp #6346

merged 3 commits into from
Feb 28, 2025

Conversation

ESadek-MO
Copy link
Contributor

@ESadek-MO ESadek-MO commented Feb 28, 2025 •
edited
Loading

🚀 Pull Request

Description

Added some convenience enums to quickplot, to supplement #6247.

from iris.quickplot import Classification

qplt.contour(cube, footer=Classification.official_sensitive)
iplot.show()

Which offers more consistency than:

qplt.contour(cube, footer="Official-Sensitive")
iplot.show()

@codecov Codecov
Copy link

codecov bot commented Feb 28, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.78%. Comparing base (010389c) to head (24e5f6a).
Report is 85 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #6346   +/-   ##
=======================================
  Coverage   89.78%   89.78%           
=======================================
  Files          90       90           
  Lines       23548    23554    +6     
  Branches     4391     4391           
=======================================
+ Hits        21143    21149    +6     
  Misses       1662     1662           
  Partials      743      743

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

trexfeathers
trexfeathers requested changes Feb 28, 2025
View reviewed changes
Copy link
Contributor

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

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

iris/docs/src/conf.py

Lines 201 to 211 in 8fa0cdb

# sphinx.ext.autodoc configuration --------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_options
autodoc_default_options = {
"members": True,
"member-order": "alphabetical",
"undoc-members": True,
"private-members": False,
"special-members": False,
"inherited-members": True,
"show-inheritance": True,
} 

-    "inherited-members": True
+    # Enums are most valuable when documented as concisely as possible.
+    "inherited-members": "Enum,IntEnum,ReprEnum,StrEnum",

https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-option-autoclass-inherited-members

trexfeathers
trexfeathers requested changes Feb 28, 2025
View reviewed changes
@trexfeathers trexfeathers self-assigned this Feb 28, 2025
@trexfeathers trexfeathers merged commit ed45606 into SciTools:main Feb 28, 2025
21 checks passed
ukmo-ccbunney added a commit to ukmo-ccbunney/iris that referenced this pull request Feb 28, 2025
@ukmo-ccbunney
Merge remote-tracking branch 'upstream/main' into varlen_str_type
1c34e42 
* upstream/main:
  Faster dimension lookup for derived coordinates (SciTools#6337)
  Unpin dask 2 (SciTools#6342)
  added classification enums to qp (SciTools#6346)
  Add castable check for valid_range, valid_min, valid_max. (SciTools#6343)
  Pin Sphinx below 8.2 (SciTools#6344)
  Add a text feature to quickplot (SciTools#6333)
@github-actions github-actions bot mentioned this pull request Mar 1, 2025
Closed
@scitools-ci scitools-ci bot removed this from 🚴 Peloton Mar 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trexfeathers trexfeathers trexfeathers approved these changes

Assignees

@trexfeathers trexfeathers

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ESadek-MO @trexfeathers