Skip to content

[Docs] Remove obsolete example about catching ConfigError #7

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 24, 2025
Merged

[Docs] Remove obsolete example about catching ConfigError #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions Sources/Configuration/Documentation.docc/Guides/Choosing-reader-methods.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,25 +169,6 @@ Use required variants when:
- **Critical functionality**: Configuration that must be present for core features to work.
- **Fail-fast behavior**: You want immediate errors for missing critical configuration.

#### Error types

Required variants throw specific errors for different failure scenarios:

```swift
do {
let port = try config.requiredInt(forKey: "server.port")
} catch ConfigError.missingRequiredConfigValue(let key) {
// The configuration key wasn't found in any provider
print("Missing required config: \(key)")
} catch ConfigError.configValueNotConvertible(let name, let type) {
// The value exists but can't be converted to the expected type
print("Config '\(name)' can't convert to \(type)")
} catch {
// Provider-specific errors (network issues, file not found, etc.)
print("Provider error: \(error)")
}
```

### Choosing the right variant

Use this decision tree to select the appropriate variant:
Expand Down
Loading