doc: correct note on behavior of stats.isDirectory

PR-URL: #50946 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Mar 25, 2024 · 2a61602 · 2a61602
1 parent 184b8be
commit 2a61602
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -6932,8 +6932,9 @@ added: v0.1.10
 
 Returns `true` if the {fs.Stats} object describes a file system directory.
 
-If the {fs.Stats} object was obtained from [`fs.lstat()`][], this method will
-always return `false`. This is because [`fs.lstat()`][] returns information
+If the {fs.Stats} object was obtained from calling [`fs.lstat()`][] on a
+symbolic link which resolves to a directory, this method will return `false`.
+This is because [`fs.lstat()`][] returns information
 about a symbolic link itself and not the path it resolves to.
 
 #### `stats.isFIFO()`