-
Notifications
You must be signed in to change notification settings - Fork 286
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
first cut at API docs #8
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙏 ❤️
Sources/Logging/Logging.swift
Outdated
case dictionary(Metadata) | ||
|
||
/// A metadata value which is an array of `Logger.Metadata.Value`s. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Logger.Metadata.Value -> MetadataValue?
/// A `Logger` is the central type in `swift-log`. Its central function is to emit log messages using one of the methods | ||
/// corresponding to a log level. | ||
/// | ||
/// The most basic usage of a `Logger` is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some comments in line; some small typos and some rewording proposals.
Anything not commented on is Looking Good™ 👍
same thing here: it's far from perfect but it's a start for API docs.