Skip to content

Commit

Permalink
docs: fix 'stream' argument for job_logs_buffered (#81)
Browse files Browse the repository at this point in the history
  • Loading branch information
mortenpi authored Feb 10, 2025
1 parent 36ff074 commit 49fafb1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/jobs/logging.jl
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ function haslast end
"""
JuliaHub.job_logs_buffered(
[f::Base.Callable], job::Union{Job,AbstractString};
streaming::Bool=true, [offset::Integer],
stream::Bool=true, [offset::Integer],
[auth::Authentication]
) -> AbstractJobLogsBuffer
Expand All @@ -228,15 +228,15 @@ The function accepts the following arguments:
The first argument is the buffer object itself, and the second argument will be passed a _read-only
view_ of all the logs that have been loaded into the buffer, including the new ones.
* `job :: Union{Job,AbstractString}`: either the job name or a [`Job`](@ref) object.
* `streaming :: Bool`: if set to `true`, the buffer object The streaming can be stopped with
[`interrupt!`](@ref).
* `stream :: Bool`: if set to `true`, the buffer object will automatically pull new logs in a
an asynchronous background task. The streaming can be stopped with [`interrupt!`](@ref).
* `offset :: Integer`: optional non-negative value to specify the starting point of the buffer
# Interface of the returned object
Returns an instance of the abstract [`AbstractJobLogsBuffer`](@ref) type.
These objects contain log messages (of type [`JobLogMessage`](@ref)), but not all the log messages
are immediately available. Instead, at any given time the buffer represents a continous section of
are immediately available. Instead, at any given time the buffer represents a continuous section of
logs that can be extended in either direction.
The following functions can be used to interact with log buffers: [`job_logs_newer!`](@ref),
Expand Down

0 comments on commit 49fafb1

Please sign in to comment.