Update documentation to reflect recent changes#445
Open
samuelmurray wants to merge 3 commits intoapple:mainfrom
Open
Update documentation to reflect recent changes#445samuelmurray wants to merge 3 commits intoapple:mainfrom
samuelmurray wants to merge 3 commits intoapple:mainfrom
Conversation
kukushechkin
approved these changes
Apr 16, 2026
Contributor
kukushechkin
left a comment
There was a problem hiding this comment.
Thanks for this documentation update, @samuelmurray!
Co-authored-by: Vladimir Kukushkin <kukushechkin@mac.com>
heckj
approved these changes
Apr 16, 2026
Contributor
|
An additional thank you @samuelmurray - on top of @kukushechkin ! Appreciate you taking the time with this! |
samuelmurray
commented
Apr 16, 2026
Contributor
|
FYI, the CI is in shambles (not only in this repo), there is nothing wrong with the PR. |
auto-merge was automatically disabled
April 16, 2026 20:15
Head branch was pushed to by a user without write access
Contributor
Author
|
After looking at the documentation at swiftpackageindex, I realised that the |
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.
Update documentation to reflect recent changes
Motivation:
The documentation was not updated in SLG-0003 or SLG-0005. Concretely, the examples given in the documentation used the now deprecated multiparameter methods in
LogHandler, and the newLogEvent-based method were not listed among the others. Likewise, the new logging methods (Logger.traceetc.) that take anErroras a parameter were not added. Lastly,LogEventhad no separate entry.While the default rendered docs for these were acceptable, it decreased the discoverability of the new methods, and the examples using deprecated methods were misleading.
Modifications:
LoggerandLogHandleralong the existing ones.LogEventto give it the same look as all other types..mdfiles to follow swift format.Result:
Documentation reflects the current state and best practices of
swift-log.