docs: explain exposure levels #76
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation explaining WrkstrmLog's exposure level system, detailing how global and per-logger limits control message visibility. The documentation clarifies the relationship between Log.globalExposureLevel and individual logger maxExposureLevel settings.
Key Changes
- Documents the global exposure level configuration via
Log.globalExposureLevel - Explains per-logger exposure limits using
maxExposureLevelparameter - Notes the removal of the deprecated
Log.removeExposureLimitAPI
Comment on lines
+166
to
+168
| if libraryLogger.maxExposureLevel >= .debug { | ||
| libraryLogger.debug("Handshake succeeded") | ||
| } |
There was a problem hiding this comment.
The conditional check if libraryLogger.maxExposureLevel >= .debug is redundant since the logger's debug method already respects the exposure level internally. This example suggests manual checking is required when the library handles this automatically.
Suggested change
| if libraryLogger.maxExposureLevel >= .debug { | |
| libraryLogger.debug("Handshake succeeded") | |
| } | |
| libraryLogger.debug("Handshake succeeded") |
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
Testing
swift testswiftlint(fails: command not found)https://chatgpt.com/codex/tasks/task_e_68aa0ac36f88833381175bd00f31931c