Repository navigation
Docstrings: correct locale activation return type and thread scope - #442
Merged
Merged
Conversation
hugovk
changed the title
Document the translation object returned by activate() and clarify that activation and deactivation apply to the calling thread. Prepared with AI assistance (OpenAI Codex).
hugovk
enabled auto-merge (squash)
November 12, 2026 11:45
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #442 +/- ##
=======================================
Coverage 97.35% 97.35%
=======================================
Files 12 12
Lines 1022 1022
=======================================
Hits 995 995
Misses 27 27
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Changes proposed in this pull request:
activate()'s documented return type fromdicttogettext.NullTranslations, matching its annotation and the translation objects it returns.activate()anddeactivate()affect the calling thread, matching thethreading.local()state.Validation: compiled the translation catalogs with the project script;
pytest tests/test_i18n.py -qpassed all 118 tests;ruff check src/humanize/i18n.pypassed. A separate runtime check confirmed the return types and that changing a worker thread's locale leaves the main thread's locale unchanged.Only docstrings change. Prepared with AI assistance (OpenAI Codex).