Skip to content

Conversation

@d-chambers
Copy link
Contributor

Description

This PR fixes the PatchType and SpoolType typevars in the constants module.

These are typevars which bind to a string (eg "dc.Patch") so other functions can use them and yet avoid circular imports.

However, in #456 I had changed the bound string to "dc.Patch" to better support the idiomatic import of dascore as dc when using patch_function's new validate_call feature. However, this broke a lot of the doc-build stuff which expected 'dascore.Patch'. This PR modifies the doc build's type indexing to allow for dc.{whatever} or dascore.{whatever}.

Checklist

I have (if applicable):

  • referenced the GitHub issue this PR closes.
  • documented the new feature with docstrings or appropriate doc page.
  • included a test. See testing guidelines.
  • your name has been added to the contributors page (docs/contributors.md).
  • added the "ready_for_review" tag once the PR is ready to be reviewed.

@codecov
Copy link

codecov bot commented Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.85%. Comparing base (aa0f62d) to head (2ad9db9).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #458   +/-   ##
=======================================
  Coverage   99.85%   99.85%           
=======================================
  Files         115      115           
  Lines        9372     9372           
=======================================
  Hits         9358     9358           
  Misses         14       14           
Flag Coverage Δ
unittests 99.85% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@d-chambers d-chambers merged commit ad2ecb5 into master Nov 8, 2024
@d-chambers d-chambers deleted the fix_patch_type_var branch November 8, 2024 14:55
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