Minor tweaks

This commit is contained in:
Sindre Sorhus 2022-12-08 19:15:16 +01:00
parent 5d1d7932a9
commit d71bfd8ffb
2 changed files with 10 additions and 10 deletions

View File

@ -102,19 +102,19 @@ extension Defaults {
/** /**
Create a key. Create a key.
- Parameter key: The key must be ASCII, not start with `@`, and cannot contain a dot (`.`). - Parameter name: The name must be ASCII, not start with `@`, and cannot contain a dot (`.`).
The `default` parameter should not be used if the `Value` type is an optional. The `default` parameter should not be used if the `Value` type is an optional.
*/ */
@_alwaysEmitIntoClient @_alwaysEmitIntoClient
public init( public init(
_ key: String, _ name: String,
default defaultValue: Value, default defaultValue: Value,
suite: UserDefaults = .standard suite: UserDefaults = .standard
) { ) {
self.defaultValueGetter = { defaultValue } self.defaultValueGetter = { defaultValue }
super.init(name: key, suite: suite) super.init(name: name, suite: suite)
if (defaultValue as? _DefaultsOptionalProtocol)?.isNil == true { if (defaultValue as? _DefaultsOptionalProtocol)?.isNil == true {
return return
@ -139,19 +139,19 @@ extension Defaults {
} }
``` ```
- Parameter key: The key must be ASCII, not start with `@`, and cannot contain a dot (`.`). - Parameter name: The name must be ASCII, not start with `@`, and cannot contain a dot (`.`).
- Note: This initializer will not set the default value in the actual `UserDefaults`. This should not matter much though. It's only really useful if you use legacy KVO bindings. - Note: This initializer will not set the default value in the actual `UserDefaults`. This should not matter much though. It's only really useful if you use legacy KVO bindings.
*/ */
@_alwaysEmitIntoClient @_alwaysEmitIntoClient
public init( public init(
_ key: String, _ name: String,
suite: UserDefaults = .standard, suite: UserDefaults = .standard,
default defaultValueGetter: @escaping () -> Value default defaultValueGetter: @escaping () -> Value
) { ) {
self.defaultValueGetter = defaultValueGetter self.defaultValueGetter = defaultValueGetter
super.init(name: key, suite: suite) super.init(name: name, suite: suite)
} }
} }
} }
@ -161,14 +161,14 @@ extension Defaults.Key {
/** /**
Create a key with an optional value. Create a key with an optional value.
- Parameter key: The key must be ASCII, not start with `@`, and cannot contain a dot (`.`). - Parameter name: The name must be ASCII, not start with `@`, and cannot contain a dot (`.`).
*/ */
@_transparent @_transparent
public convenience init<T>( public convenience init<T>(
_ key: String, _ name: String,
suite: UserDefaults = .standard suite: UserDefaults = .standard
) where Value == T? { ) where Value == T? {
self.init(key, default: nil, suite: suite) self.init(name, default: nil, suite: suite)
} }
} }

View File

@ -347,7 +347,7 @@ Stores the keys.
#### `Defaults.Key` _(alias `Defaults.Keys.Key`)_ #### `Defaults.Key` _(alias `Defaults.Keys.Key`)_
```swift ```swift
Defaults.Key<T>(_ key: String, default: T, suite: UserDefaults = .standard) Defaults.Key<T>(_ name: String, default: T, suite: UserDefaults = .standard)
``` ```
Type: `class` Type: `class`