Skip to content

Commit 5ae424b

Browse files
authored
Update docstring of FileProduct (#380)
1 parent e985cbf commit 5ae424b

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/Products.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -440,10 +440,11 @@ function locate(ep::ExecutableProduct, prefix::Prefix; platform::AbstractPlatfor
440440
end
441441

442442
"""
443-
FileProduct(path::AbstractString, varname::Symbol, dir_path = nothing)
443+
FileProduct(path, varname::Symbol, dir_path = nothing)
444444
445445
Declares a [`FileProduct`](@ref) that points to a file located relative to the root of
446-
a `Prefix`, must simply exist to be satisfied.
446+
a `Prefix`, must simply exist to be satisfied. The first argument `path` is either a single `AbstractString`
447+
or a `Vector{String}` to allow several paths to be checked.
447448
"""
448449
struct FileProduct <: Product
449450
paths::Vector{String}

0 commit comments

Comments
 (0)