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

Annotate cat_list() #896

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Annotate cat_list() #896

wants to merge 1 commit into from

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
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 (5c0b44f) to head (8d3b772).

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #896   +/-   ##
=====================================
  Coverage   95.6%   95.6%           
=====================================
  Files         46      46           
  Lines       4337    4337           
=====================================
  Hits        4147    4147           
  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
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.

1 participant