Fix README documentation examples for obfuscator methods#34
Merged
gildas merged 2 commits intofeature/obfuscatorfrom Feb 8, 2026
Merged
Fix README documentation examples for obfuscator methods#34gildas merged 2 commits intofeature/obfuscatorfrom
gildas merged 2 commits intofeature/obfuscatorfrom
Conversation
Merged
Co-authored-by: gildas <56485+gildas@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add obfuscation capability to logger package
Fix README documentation examples for obfuscator methods
Feb 8, 2026
gildas
approved these changes
Feb 8, 2026
There was a problem hiding this comment.
Pull request overview
This PR corrects the README’s obfuscation documentation examples so they call Obfuscate/Unobfuscate on the *logger.Logger instance (as implemented in code), and updates the Unobfuscate example to handle its (string, error) return.
Changes:
- Updated the
Obfuscateexample to calllog.Obfuscate(...)instead oflogger.Obfuscate(...). - Updated the
Unobfuscateexample to calllog.Unobfuscate(...)and handle the returned error.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Addressed two issues in the obfuscator documentation examples where methods were incorrectly called on the package instead of the logger instance.
Changes:
logger.Obfuscate()→log.Obfuscate()to call method on logger instancelogger.Unobfuscate()→log.Unobfuscate()with proper error handling for the(string, error)return signatureCorrected example:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.