Fixed type hint/docstring on DocMetadataClient.metadata_clients#1086
Merged
jamesbraza merged 1 commit intomainfrom Sep 13, 2025
Merged
Fixed type hint/docstring on DocMetadataClient.metadata_clients#1086jamesbraza merged 1 commit intomainfrom
DocMetadataClient.metadata_clients#1086jamesbraza merged 1 commit intomainfrom
Conversation
jamesbraza
requested review from
maykcaldas,
mskarlin,
nadolskit and
whitead
dosubot
bot
added
the
size:S
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the type hints and documentation for the DocMetadataClient.metadata_clients parameter to accurately reflect that it supports both class types and instances of MetadataProvider and MetadataPostProcessor.
- Introduces a new
MetadataClientQueriertype alias that includes both instances and class types - Updates the
metadata_clientsparameter type annotation to use this new alias - Improves the docstring to clarify that both instances and classes are supported
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Related Documentation Checked 1 published document(s). No updates required. How did I do? Any feedback? |
whitead
approved these changes
Sep 13, 2025
|
Documentation Updates Checked 1 published document(s). No updates required. How did I do? Any feedback? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I realized we were only allowing classes, when in fact we support instances too.