Skip to content

Commit 01a73c2

Browse files
docs: fix docs for accepted inputs for directories
1 parent 3104b7a commit 01a73c2

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ The crate automatically handles:
4949

5050
### Required parameter
5151

52-
- `path_to_dir` - a valid Rust identifier or `&str` of the path to the static files to be included
52+
- `path_to_dir` - a valid `&str` string literal of the path to the static files to be included
5353

5454
### Optional parameters
5555

5656
- `compress = false` - compress static files with zstd and gzip, true or false (defaults to false)
5757

58-
- `ignore_dirs = [my_ignore_dir, other_ignore_dir]` - a bracketed list of valid Rust identifiers or `&str`s of the paths/subdirectories inside the target directory, which should be ignored and not included. (If this parameter is missing, no subdirectories will be ignored)
58+
- `ignore_dirs = [my_ignore_dir, other_ignore_dir]` - a bracketed list of `&str`s of the paths/subdirectories inside the target directory, which should be ignored and not included. (If this parameter is missing, no subdirectories will be ignored)
5959

6060
## Example
6161

static-serve/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ The crate automatically handles:
4646

4747
### Required parameter
4848

49-
- `path_to_dir` - a valid Rust identifier or `&str` of the path to the static files to be included
49+
- `path_to_dir` - a valid `&str` string literal of the path to the static files to be included
5050

5151
### Optional parameters
5252

5353
- `compress = false` - compress static files with zstd and gzip, true or false (defaults to false)
54-
- `ignore_dirs = [my_ignore_dir, other_ignore_dir]` - a bracketed list of valid Rust identifiers or `&str`s of the paths/subdirectories inside the target directory, which should be ignored and not included. (If this parameter is missing, no subdirectories will be ignored)
54+
- `ignore_dirs = [my_ignore_dir, other_ignore_dir]` - a bracketed list of `&str`s of the paths/subdirectories inside the target directory, which should be ignored and not included. (If this parameter is missing, no subdirectories will be ignored)
5555

5656
## Example
5757

0 commit comments

Comments
 (0)