Skip to content

Conversation

@glatterf42
Copy link
Member

@glatterf42 glatterf42 commented Dec 4, 2024

This PR comes from me wanting to showcase a small, completely typed function in the UBA presentation on Tuesday as an example for how to use docstrings. I didn't want to spend too much time looking, cat_list() seems fine, but is missing some annotations. This PR provides them.

How to review

No need to merge this (quickly), I'm mainly interested in the docs built from this PR. But of course, this is a small improvement we can bring in anytime :)

  • Read the diff and note that the CI checks all pass.

PR checklist

  • Continuous integration checks all ✅
  • [ ] Add or expand tests; coverage checks both ✅ Just adding annotations.
  • Add, expand, or update documentation.
  • [ ] Update release notes. Just adding annotations.

@glatterf42 glatterf42 added the enh New features & functionality label Dec 4, 2024
@glatterf42 glatterf42 self-assigned this Dec 4, 2024
@codecov
Copy link

codecov bot commented Dec 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.6%. Comparing base (ab9b707) to head (ab60564).
Report is 52 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #896   +/-   ##
=====================================
  Coverage   95.6%   95.6%           
=====================================
  Files         46      46           
  Lines       4338    4338           
=====================================
  Hits        4148    4148           
  Misses       190     190           
Files with missing lines Coverage Δ
message_ix/core.py 97.7% <100.0%> (ø)

@glatterf42 glatterf42 requested a review from khaeru December 4, 2024 12:36
@khaeru
Copy link
Member

khaeru commented Jan 7, 2025

Should we now merge this?

@glatterf42
Copy link
Member Author

Good to merge anytime :)

@khaeru
Copy link
Member

khaeru commented Jan 7, 2025

The stalled check "Code scanning results / CodeQL" seems to be spurious, due to some change in GitHub's behaviour. I'll ignore it and merge.

@khaeru khaeru merged commit 1c7ab17 into main Jan 7, 2025
27 checks passed
@khaeru khaeru deleted the type-hint-cat-list branch January 7, 2025 14:38
@khaeru khaeru added this to the 3.10 milestone Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enh New features & functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants