Documenting DocMetadataTask/MetadataProvider
#1050
Merged
Conversation
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
dosubot
bot
added
the
size:M
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation and naming for the metadata provider system. The purpose is to make the codebase more understandable for future developers working with metadata retrieval functionality.
- Renamed
query_transformertoquery_factoryfor clearer naming - Added comprehensive docstrings to the
MetadataProviderandDocMetadataTaskclasses - Enhanced field descriptions with concrete examples
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/paperqa/clients/client_models.py | Renamed query_transformer to query_factory and added docstrings to MetadataProvider abstract methods |
| src/paperqa/clients/init.py | Added detailed docstrings to DocMetadataTask class and its methods, plus field descriptions with examples |
nadolskit
approved these changes
Aug 7, 2025
jamesbraza
added a commit
that referenced
this pull request
Aug 25, 2025
jamesbraza
added a commit
that referenced
this pull request
Aug 26, 2025
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 was having a tough time re-groking this, so I added docs for the next person.
I also renamed
query_transformertoquery_factoryto be more explicit.