Skip to content

Commit

Permalink
update doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
fatteneder committed Feb 14, 2024
1 parent 708a68b commit 7c7c8aa
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions base/sysinfo.jl
Original file line number Diff line number Diff line change
Expand Up @@ -575,7 +575,17 @@ isexecutable(path::AbstractString) = isexecutable(String(path))
"""
Sys.isreadable(path::String)
Return `true` if the given `path` has readable permissions.
Return `true` if the access permissions for the given `path` permitted reading by the current user.
!!! note
This permission may change before the user calls `open`,
so it is recommended to just call `open` alone and handle the error if that fails,
rather than calling `isreadable` first.
!!! comapt "Julia 1.11"
This function requires at least Julia 1.11.
See also [`ispath`](@ref).
"""
function isreadable(path::String)
# We use `access()` and `R_OK` to determine if a given path is
Expand All @@ -588,7 +598,17 @@ isreadable(path::AbstractString) = isreadable(String(path))
"""
Sys.iswriteable(path::String)
Return `true` if the given `path` has writeable permissions.
Return `true` if the access permissions for the given `path` permitted writing by the current user.
!!! note
This permission may change before the user calls `open`,
so it is recommended to just call `open` alone and handle the error if that fails,
rather than calling `iswriteable` first.
!!! comapt "Julia 1.11"
This function requires at least Julia 1.11.
See also [`ispath`](@ref).
"""
function iswriteable(path::String)
# We use `access()` and `W_OK` to determine if a given path is
Expand Down

0 comments on commit 7c7c8aa

Please sign in to comment.