diff options
| author | Tobias Nießen <tniessen@tnie.de> | 2023-04-19 19:40:46 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-19 17:40:46 +0000 |
| commit | 9a7b9710e21f352fe002ff2b8b872b383054c770 (patch) | |
| tree | ece897feb2348b496a9b78c28fa2495b28792105 /doc/api | |
| parent | 4956271c93fa65be227e7f12648a86edf66c2c18 (diff) | |
| download | node-new-9a7b9710e21f352fe002ff2b8b872b383054c770.tar.gz | |
doc: improve fs permissions description
Fix a small grammatical mistake and improve the surrounding wording.
PR-URL: https://github.com/nodejs/node/pull/47596
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/cli.md | 10 | ||||
| -rw-r--r-- | doc/api/permissions.md | 6 |
2 files changed, 10 insertions, 6 deletions
diff --git a/doc/api/cli.md b/doc/api/cli.md index f41af65822..2f5d422333 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -154,8 +154,9 @@ the [Permission Model][]. The valid arguments for the `--allow-fs-read` flag are: -* `*` - To allow the `FileSystemRead` operations. -* Paths delimited by comma (,) to manage `FileSystemRead` (reading) operations. +* `*` - To allow all `FileSystemRead` operations. +* Paths delimited by comma (`,`) to allow only matching `FileSystemRead` + operations. Examples can be found in the [File System Permissions][] documentation. @@ -200,8 +201,9 @@ the [Permission Model][]. The valid arguments for the `--allow-fs-write` flag are: -* `*` - To allow the `FileSystemWrite` operations. -* Paths delimited by comma (,) to manage `FileSystemWrite` (writing) operations. +* `*` - To allow all `FileSystemWrite` operations. +* Paths delimited by comma (`,`) to allow only matching `FileSystemWrite` + operations. Examples can be found in the [File System Permissions][] documentation. diff --git a/doc/api/permissions.md b/doc/api/permissions.md index ad41e4f290..0b48a682dc 100644 --- a/doc/api/permissions.md +++ b/doc/api/permissions.md @@ -520,8 +520,10 @@ Hello world! The valid arguments for both flags are: -* `*` - To allow the all operations to given scope (read/write). -* Paths delimited by comma (,) to manage reading/writing operations. +* `*` - To allow all `FileSystemRead` or `FileSystemWrite` operations, + respectively. +* Paths delimited by comma (`,`) to allow only matching `FileSystemRead` or + `FileSystemWrite` operations, respectively. Example: |