Skip to content

Commit

Permalink
Fix a documentation line that was a bit too wide
Browse files Browse the repository at this point in the history
  • Loading branch information
winsmith committed Jun 14, 2024
1 parent 1a32217 commit 6729873
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
11 changes: 6 additions & 5 deletions Sources/TelemetryClient/Presets/TelemetryDeck+Errors.swift
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import Foundation

extension TelemetryDeck {
public extension TelemetryDeck {
/// Sends a telemetry signal indicating that an error has occurred.
///
/// - Parameters:
Expand All @@ -10,7 +10,7 @@ extension TelemetryDeck {
/// - parameters: Additional parameters to include with the signal. Default is an empty dictionary.
/// - floatValue: An optional floating-point value to include with the signal. Default is `nil`.
/// - customUserID: An optional custom user identifier. If provided, it overrides the default user identifier from the configuration. Default is `nil`.
public static func errorOccurred(
static func errorOccurred(
id: String,
category: ErrorCategory? = nil,
message: String? = nil,
Expand Down Expand Up @@ -44,7 +44,7 @@ extension TelemetryDeck {
/// - parameters: Additional parameters to include with the signal. Default is an empty dictionary.
/// - floatValue: An optional floating-point value to include with the signal. Default is `nil`.
/// - customUserID: An optional custom user identifier. If provided, it overrides the default user identifier from the configuration. Default is `nil`.
public static func errorOccurred(
static func errorOccurred(
identifiableError: IdentifiableError,
category: ErrorCategory = .thrownException,
parameters: [String: String] = [:],
Expand All @@ -71,9 +71,10 @@ extension TelemetryDeck {
/// - floatValue: An optional floating-point value to include with the signal. Default is `nil`.
/// - customUserID: An optional custom user identifier. If provided, it overrides the default user identifier from the configuration. Default is `nil`.
///
/// - Note: Use this overload if you want to provide a custom `message` parameter. Prefer ``errorOccurred(identifiableError:category:parameters:floatValue:customUserID:)`` to send `error.localizedDescription` as the `message` automatically.
/// - Note: Use this overload if you want to provide a custom `message` parameter. Prefer ``errorOccurred(identifiableError:category:parameters:floatValue:customUserID:)`` to send
/// `error.localizedDescription` as the `message` automatically.
@_disfavoredOverload
public static func errorOccurred(
static func errorOccurred(
identifiableError: IdentifiableError,
category: ErrorCategory = .thrownException,
message: String? = nil,
Expand Down
6 changes: 3 additions & 3 deletions Sources/TelemetryClient/TelemetryDeck.swift
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ public enum TelemetryDeck {
/// This is a convenience method that will internally send a completely normal TelemetryDeck signals with the type
/// `TelemetryDeck.Route.Transition.navigation` and the necessary payload.
///
/// Since TelemetryDeck navigation signals need a source and a destination, this method will keep track of the last
/// Since TelemetryDeck navigation signals need a source and a destination, this method will store the last
/// used destination for use in the `navigate(to:)` method.
///
/// ## Navigation Paths
/// Navigation Paths are strings that indicate a location or view in your application or website. They must be
/// Navigation Paths are strings that describe a location or view in your application or website. They must be
/// delineated by either `.` or `/` characters. Delineation characters at the beginning and end of the string are
/// ignored. Use the empty string `""` for navigation from outside the app. Examples are `index`,
/// `settings.user.changePassword`, or `/blog/ios-market-share`.
Expand Down Expand Up @@ -79,7 +79,7 @@ public enum TelemetryDeck {
/// `TelemetryDeck.Route.Transition.navigation` and the necessary payload.
///
/// ## Navigation Paths
/// Navigation Paths are strings that indicate a location or view in your application or website. They must be
/// Navigation Paths are strings that describe a location or view in your application or website. They must be
/// delineated by either `.` or `/` characters. Delineation characters at the beginning and end of the string are
/// ignored. Use the empty string `""` for navigation from outside the app. Examples are `index`,
/// `settings.user.changePassword`, or `/blog/ios-market-share`.
Expand Down

0 comments on commit 6729873

Please sign in to comment.