feat: improve documentation and add tests for existing quick-win features #44
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
This PR verifies and improves the implementation of three quick-win features that were already implemented in the recent refactoring: 1. Image Watermark Support (Issue #11) - Already supports FileInput (str, Path, bytes, file-like, URL) - Improved docstring with comprehensive examples - Added unit tests for bytes and Path inputs 2. Multi-Language OCR Support (Issue #10) - Already supports List[OcrLanguage] for multiple languages - Improved docstring with multi-language examples - Added unit tests for three languages and ISO codes 3. Selective Annotation Flattening (Issue #12) - Already supports annotation_ids parameter (str or int) - Improved docstring with examples for string, int, and mixed IDs - Added comprehensive unit tests for all ID types All features maintain backward compatibility. 257 unit tests passing.
HungKNguyen
approved these changes
Jan 13, 2026
Collaborator
HungKNguyen
left a comment
HungKNguyen
left a comment
There was a problem hiding this comment.
LGTM, all test are passing and documentation additions make sense
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.
Summary
This PR verifies and improves the implementation of three quick-win features that were already implemented in the recent refactoring:
1. Image Watermark Support (Issue #11)
FileInput(str, Path, bytes, file-like, URL)2. Multi-Language OCR Support (Issue #10)
List[OcrLanguage]for multiple languages3. Selective Annotation Flattening (Issue #12)
annotation_idsparameter (str or int)Changes
src/nutrient_dws/client.py: Enhanced docstrings forflatten(),ocr(), andwatermark_image()tests/unit/test_client.py: Added 8 new unit tests for these featuresTesting
All 257 unit tests passing.
Backward Compatibility
All changes maintain full backward compatibility with existing API.