Merge pull request #24709 from JuliaLang/ksh/fsdts

Doctests for some filesystem methods

Author: kshyatt

base/stat.jl

@@ -165,26 +165,53 @@ Returns `true` if `path` is a FIFO, `false` otherwise.
 
 Returns `true` if `path` is a character device, `false` otherwise.
 """
- ischardev(st::StatStruct) = filemode(st) & 0xf000 == 0x2000
+ischardev(st::StatStruct) = filemode(st) & 0xf000 == 0x2000
 
- """
-     isdir(path) -> Bool
+"""
+    isdir(path) -> Bool
+
+Returns `true` if `path` is a directory, `false` otherwise.
+
+# Examples
+```jldoctest
+julia> isdir(homedir())
+true
 
- Returns `true` if `path` is a directory, `false` otherwise.
- """
-     isdir(st::StatStruct) = filemode(st) & 0xf000 == 0x4000
+julia> f = open("test_file.txt", "w")
+IOStream(<file test_file.txt>)
+
+julia> isdir(f)
+false
+
+julia> close(f)
+```
+"""
+    isdir(st::StatStruct) = filemode(st) & 0xf000 == 0x4000
 
- """
-     isblockdev(path) -> Bool
+"""
+    isblockdev(path) -> Bool
 
- Returns `true` if `path` is a block device, `false` otherwise.
- """
+Returns `true` if `path` is a block device, `false` otherwise.
+"""
 isblockdev(st::StatStruct) = filemode(st) & 0xf000 == 0x6000
 
 """
     isfile(path) -> Bool
 
 Returns `true` if `path` is a regular file, `false` otherwise.
+
+# Examples
+```jldoctest
+julia> isfile(homedir())
+false
+
+julia> f = open("test_file.txt", "w");
+
+julia> isfile(f)
+true
+
+julia> close(f)
+```
 """
     isfile(st::StatStruct) = filemode(st) & 0xf000 == 0x8000