Skip to content

Commit 250cef0

Browse files
grundoonweissi
grundoon
authored and
weissi
committed
fix docs #file -> #function (#59)
* fix docs #file -> #function Multiple occurrences of `#file` in docs where `#function` was intended. * add missing parentheses to parameter docs
1 parent 33ceed2 commit 250cef0

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

Diff for: ‎Sources/Logging/Logging.swift

+24-24
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ extension Logger {
4747
/// - message: The message to be logged. `message` can be used with any string interpolation literal.
4848
/// - metadata: One-off metadata to attach to this log message
4949
/// - file: The file this log message originates from (there's usually no need to pass it explicitly as it
50-
/// defaults to `#file`.
50+
/// defaults to `#file`).
5151
/// - function: The function this log message originates from (there's usually no need to pass it explicitly as
52-
/// it defaults to `#file`.
52+
/// it defaults to `#function`).
5353
/// - line: The line this log message originates from (there's usually no need to pass it explicitly as it
54-
/// defaults to `#line`.
54+
/// defaults to `#line`).
5555
@inlinable
5656
public func log(level: Logger.Level,
5757
_ message: @autoclosure () -> Logger.Message,
@@ -107,11 +107,11 @@ extension Logger {
107107
/// - message: The message to be logged. `message` can be used with any string interpolation literal.
108108
/// - metadata: One-off metadata to attach to this log message
109109
/// - file: The file this log message originates from (there's usually no need to pass it explicitly as it
110-
/// defaults to `#file`.
110+
/// defaults to `#file`).
111111
/// - function: The function this log message originates from (there's usually no need to pass it explicitly as
112-
/// it defaults to `#file`.
112+
/// it defaults to `#function`).
113113
/// - line: The line this log message originates from (there's usually no need to pass it explicitly as it
114-
/// defaults to `#line`.
114+
/// defaults to `#line`).
115115
@inlinable
116116
public func trace(_ message: @autoclosure () -> Logger.Message,
117117
metadata: @autoclosure () -> Logger.Metadata? = nil,
@@ -129,11 +129,11 @@ extension Logger {
129129
/// - message: The message to be logged. `message` can be used with any string interpolation literal.
130130
/// - metadata: One-off metadata to attach to this log message
131131
/// - file: The file this log message originates from (there's usually no need to pass it explicitly as it
132-
/// defaults to `#file`.
132+
/// defaults to `#file`).
133133
/// - function: The function this log message originates from (there's usually no need to pass it explicitly as
134-
/// it defaults to `#file`.
134+
/// it defaults to `#function`).
135135
/// - line: The line this log message originates from (there's usually no need to pass it explicitly as it
136-
/// defaults to `#line`.
136+
/// defaults to `#line`).
137137
@inlinable
138138
public func debug(_ message: @autoclosure () -> Logger.Message,
139139
metadata: @autoclosure () -> Logger.Metadata? = nil,
@@ -151,11 +151,11 @@ extension Logger {
151151
/// - message: The message to be logged. `message` can be used with any string interpolation literal.
152152
/// - metadata: One-off metadata to attach to this log message
153153
/// - file: The file this log message originates from (there's usually no need to pass it explicitly as it
154-
/// defaults to `#file`.
154+
/// defaults to `#file`).
155155
/// - function: The function this log message originates from (there's usually no need to pass it explicitly as
156-
/// it defaults to `#file`.
156+
/// it defaults to `#function`).
157157
/// - line: The line this log message originates from (there's usually no need to pass it explicitly as it
158-
/// defaults to `#line`.
158+
/// defaults to `#line`).
159159
@inlinable
160160
public func info(_ message: @autoclosure () -> Logger.Message,
161161
metadata: @autoclosure () -> Logger.Metadata? = nil,
@@ -173,11 +173,11 @@ extension Logger {
173173
/// - message: The message to be logged. `message` can be used with any string interpolation literal.
174174
/// - metadata: One-off metadata to attach to this log message
175175
/// - file: The file this log message originates from (there's usually no need to pass it explicitly as it
176-
/// defaults to `#file`.
176+
/// defaults to `#file`).
177177
/// - function: The function this log message originates from (there's usually no need to pass it explicitly as
178-
/// it defaults to `#file`.
178+
/// it defaults to `#function`).
179179
/// - line: The line this log message originates from (there's usually no need to pass it explicitly as it
180-
/// defaults to `#line`.
180+
/// defaults to `#line`).
181181
@inlinable
182182
public func notice(_ message: @autoclosure () -> Logger.Message,
183183
metadata: @autoclosure () -> Logger.Metadata? = nil,
@@ -195,11 +195,11 @@ extension Logger {
195195
/// - message: The message to be logged. `message` can be used with any string interpolation literal.
196196
/// - metadata: One-off metadata to attach to this log message
197197
/// - file: The file this log message originates from (there's usually no need to pass it explicitly as it
198-
/// defaults to `#file`.
198+
/// defaults to `#file`).
199199
/// - function: The function this log message originates from (there's usually no need to pass it explicitly as
200-
/// it defaults to `#file`.
200+
/// it defaults to `#function`).
201201
/// - line: The line this log message originates from (there's usually no need to pass it explicitly as it
202-
/// defaults to `#line`.
202+
/// defaults to `#line`).
203203
@inlinable
204204
public func warning(_ message: @autoclosure () -> Logger.Message,
205205
metadata: @autoclosure () -> Logger.Metadata? = nil,
@@ -217,11 +217,11 @@ extension Logger {
217217
/// - message: The message to be logged. `message` can be used with any string interpolation literal.
218218
/// - metadata: One-off metadata to attach to this log message
219219
/// - file: The file this log message originates from (there's usually no need to pass it explicitly as it
220-
/// defaults to `#file`.
220+
/// defaults to `#file`).
221221
/// - function: The function this log message originates from (there's usually no need to pass it explicitly as
222-
/// it defaults to `#file`.
222+
/// it defaults to `#function`).
223223
/// - line: The line this log message originates from (there's usually no need to pass it explicitly as it
224-
/// defaults to `#line`.
224+
/// defaults to `#line`).
225225
@inlinable
226226
public func error(_ message: @autoclosure () -> Logger.Message,
227227
metadata: @autoclosure () -> Logger.Metadata? = nil,
@@ -238,11 +238,11 @@ extension Logger {
238238
/// - message: The message to be logged. `message` can be used with any string interpolation literal.
239239
/// - metadata: One-off metadata to attach to this log message
240240
/// - file: The file this log message originates from (there's usually no need to pass it explicitly as it
241-
/// defaults to `#file`.
241+
/// defaults to `#file`).
242242
/// - function: The function this log message originates from (there's usually no need to pass it explicitly as
243-
/// it defaults to `#file`.
243+
/// it defaults to `#function`).
244244
/// - line: The line this log message originates from (there's usually no need to pass it explicitly as it
245-
/// defaults to `#line`.
245+
/// defaults to `#line`).
246246
@inlinable
247247
public func critical(_ message: @autoclosure () -> Logger.Message,
248248
metadata: @autoclosure () -> Logger.Metadata? = nil,

0 commit comments

Comments
 (0)