Skip to content

Commit

Permalink
Minor changes in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
peremato committed Dec 11, 2024
1 parent 59e479b commit 5d4636d
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions src/FileSystem.jl
Original file line number Diff line number Diff line change
Expand Up @@ -191,15 +191,23 @@ end
"""
Base.walkdir(fs::FileSystem, root::AbstractString; topdown=true)
List entries in a directory.
Walks in a directory tree.
# Arguments
- `fs::FileSystem`: The FileSystem object
- `root::AbstractString`: The path of the directory
- `flags::XrdCl.DirListFlags`: The flags
- `topdown::Bool`: start from the top of the directory tree
# Returns
- `Tuple` of:
- dirpath, dirnames, files
- dirpath, dirnames, files : Tuple{String,Vector{String},Vector{String}}
- Throws an exception if the operation fails.
"""
# Example
```julia
for (dirpath, dirnames, filenames) in walkdir(fs, "/tmp")
println("dirpath: $dirpath")
println("dirnames: $dirnames")
println("filenames: $filenames")
end
"""
function Base.walkdir(fs::FileSystem, root::AbstractString; topdown=true)
function _walkdir(chnl, root)
Expand Down Expand Up @@ -239,7 +247,6 @@ function Base.walkdir(fs::FileSystem, root::AbstractString; topdown=true)
return Channel{Tuple{String,Vector{String},Vector{String}}}(chnl -> _walkdir(chnl, root))
end

"""
query(fs::FileSystem, code::XRootD.XrdCl!QueryCode!Code , arg::String, timeout::UInt16=0x0000)
Expand Down

0 comments on commit 5d4636d

Please sign in to comment.