Clarify LoggerMixin usage in docstrings#3147
Merged
jonathangreen merged 2 commits intomainfrom Mar 17, 2026
Merged
Conversation
Document that self.log is the preferred way to access the logger from instance methods, and cls.logger() should only be used in classmethods or static contexts where self is unavailable.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3147 +/- ##
=======================================
Coverage 93.26% 93.26%
=======================================
Files 493 493
Lines 45579 45579
Branches 6252 6252
=======================================
Hits 42511 42511
Misses 1982 1982
Partials 1086 1086 ☔ View full report in Codecov by Sentry. 🚀 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
2 participants
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.
Description
Updates the
LoggerMixindocstrings to clarify the intended usage pattern:self.logis the preferred way to access the logger from instance methodscls.logger()should only be used in classmethods or static contexts whereselfis unavailableMotivation and Context
The existing docstrings didn't make it clear which accessor to prefer, leading to inconsistent usage across the codebase.
How Has This Been Tested?
Docstring-only change, no behavioral changes.
Checklist