Skip to content

Commit f8c4b20

Browse files
authored
DOC: missing punctuation & some grammar fixes (#307)
1 parent dc3ffe5 commit f8c4b20

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Install with `npm install rimraf`.
88
### v4 to v5
99

1010
- There is no default export anymore. Import the functions directly
11-
using, e.g., `import { rimrafSync } from 'rimraf`.
11+
using, e.g., `import { rimrafSync } from 'rimraf'`.
1212

1313
### v3 to v4
1414

@@ -21,9 +21,9 @@ Install with `npm install rimraf`.
2121
- New implementation on Windows, falling back to "move then
2222
remove" strategy when exponential backoff for `EBUSY` fails to
2323
resolve the situation.
24-
- Simplified implementation on Posix, since the Windows
24+
- Simplified implementation on POSIX, since the Windows
2525
affordances are not necessary there.
26-
- As of 4.3, return/resolve value is boolean instead of undefined
26+
- As of 4.3, return/resolve value is boolean instead of undefined.
2727

2828
## API
2929

@@ -53,7 +53,7 @@ Options:
5353
- `preserveRoot`: If set to boolean `false`, then allow the
5454
recursive removal of the root directory. Otherwise, this is
5555
not allowed.
56-
- `tmp`: Windows only. Temp folder to use to place files and
56+
- `tmp`: Windows only. Temp folder to place files and
5757
folders for the "move then remove" fallback. Must be on the
5858
same physical device as the path being deleted. Defaults to
5959
`os.tmpdir()` when that is on the same drive letter as the path
@@ -75,7 +75,7 @@ Options:
7575
linear backoff. Default `100`.
7676
- `signal` Pass in an AbortSignal to cancel the directory
7777
removal. This is useful when removing large folder structures,
78-
if you'd like to limit the amount of time spent.
78+
if you'd like to limit the time spent.
7979

8080
Using a `signal` option prevents the use of Node's built-in
8181
`fs.rm` because that implementation does not support abort
@@ -84,7 +84,7 @@ Options:
8484
- `glob` Boolean flag to treat path as glob pattern, or an object
8585
specifying [`glob` options](https://github.com/isaacs/node-glob).
8686
- `filter` Method that returns a boolean indicating whether that
87-
path should be deleted. With async rimraf methods, this may
87+
path should be deleted. With async `rimraf` methods, this may
8888
return a Promise that resolves to a boolean. (Since Promises
8989
are truthy, returning a Promise from a sync filter is the same
9090
as just not filtering anything.)
@@ -98,7 +98,7 @@ Options:
9898
if the filter returns (or resolves to) a truthy value. Omitting
9999
a directory will still allow its children to be removed, unless
100100
they are also filtered out, but any parents of a filtered entry
101-
will not be removed, since the directory would not be empty in
101+
will not be removed, since the directory will not be empty in
102102
that case.
103103

104104
Using a filter method prevents the use of Node's built-in
@@ -107,7 +107,7 @@ Options:
107107
Any other options are provided to the native Node.js `fs.rm` implementation
108108
when that is used.
109109

110-
This will attempt to choose the best implementation, based on Node.js
110+
This will attempt to choose the best implementation, based on the Node.js
111111
version and `process.platform`. To force a specific implementation, use
112112
one of the other functions provided.
113113

@@ -161,7 +161,7 @@ Note that, in cases where the operation fails, this _may_ leave
161161
files lying around in the parent directory with names like
162162
`.file-basename.txt.0.123412341`. Until the Windows kernel
163163
provides a way to perform atomic `unlink` and `rmdir` operations,
164-
this is unfortunately unavoidable.
164+
this is, unfortunately, unavoidable.
165165

166166
To move files to a different temporary directory other than the
167167
parent, provide `opts.tmp`. Note that this _must_ be on the same

0 commit comments

Comments
 (0)