Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
0xLeif committed Jan 31, 2024
1 parent afab8e3 commit 97724c0
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions Sources/AppState/Application/Application+public.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1060,11 +1060,11 @@ public extension Application {
}

/**
Retrieves a `FileManager` backed state for the provided `id`. If the state is not present, it initializes a new state with the `initial` value.
Retrieves a `FileManager` backed state for the provided `path` and `filename`. If the state is not present, it initializes a new state with the `initial` value.

- Parameters:
- initial: The closure that returns initial state value.
- path: The path to the directory containing the file. The default is `App`.
- path: The path to the directory containing the file. The default is `./App`.
- filename: The name of the file to read.
- Returns: The state of type `Value`.
*/
Expand All @@ -1080,10 +1080,10 @@ public extension Application {
}

/**
Retrieves a `FileManager` backed state for the provided `id` with a default value of `nil`.
Retrieves a `FileManager` backed state for the provided `path` and `filename` with a default value of `nil`.

- Parameters:
- path: The path to the directory containing the file. The default is `App`.
- path: The path to the directory containing the file. The default is `./App`.
- filename: The name of the file to read.
- Returns: The state of type `Value`.
*/
Expand Down

0 comments on commit 97724c0

Please sign in to comment.