Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR primarily improves documentation across multiple modules to better describe behavior and usage, addressing issue #15. Key changes include:
- Updating docstrings for NumericRange to reflect its proper purpose.
- Adding detailed argument descriptions and examples for find and facet methods in text reuse and cluster resources.
- Enhancing documentation in various API client models and containers to clarify behavior and usage.
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| impresso/structures.py | Fixed docstring for NumericRange to correctly describe it. |
| impresso/resources/text_reuse/passages.py | Added detailed function docstrings and examples for methods. |
| impresso/resources/text_reuse/clusters.py | Updated resource docstring and examples for cluster methods. |
| impresso/resources/search.py | Adjusted type annotations for filtering parameters. |
| impresso/resources/collections.py | Expanded documentation with usage examples for collections. |
| impresso/data_container.py | Clarified docstrings regarding pagination and dataframe data. |
| impresso/api_client/models/search_order_by.py | Enhanced enum members with inline comments for clarity. |
| impresso/api_client/models/find_media_sources_order_by.py | Added extensive documentation regarding ordering options. |
| impresso/api_client/models/find_entities_order_by.py | Included detailed documentation and examples for ordering. |
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
1 participant
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.
Fixes #15