Update documentation to reflect recent changes#445
Conversation
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>
|
An additional thank you @samuelmurray - on top of @kukushechkin ! Appreciate you taking the time with this! |
|
FYI, the CI is in shambles (not only in this repo), there is nothing wrong with the PR. |
Head branch was pushed to by a user without write access
|
After looking at the documentation at swiftpackageindex, I realised that the |
|
@samuelmurray the lack of those other catalogs in SPI is a result of the configuration in .spi.yaml, which currently (as I'm writing this) reads: version: 1
builder:
configs:
- documentation_targets: [Logging]Which intentionally only builds the docs for the primary Logging. A catalog for InMemoryLogging would definitely help organize things, so it'd be a lovely follow up add - along with an update to the .spi.yaml to add it into Swift Package Index's set that it builds and presents |
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.