Skip to content

Commit 49fafb1

Browse files
authored
docs: fix 'stream' argument for job_logs_buffered (#81)
1 parent 36ff074 commit 49fafb1

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/jobs/logging.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ function haslast end
214214
"""
215215
JuliaHub.job_logs_buffered(
216216
[f::Base.Callable], job::Union{Job,AbstractString};
217-
streaming::Bool=true, [offset::Integer],
217+
stream::Bool=true, [offset::Integer],
218218
[auth::Authentication]
219219
) -> AbstractJobLogsBuffer
220220
@@ -228,15 +228,15 @@ The function accepts the following arguments:
228228
The first argument is the buffer object itself, and the second argument will be passed a _read-only
229229
view_ of all the logs that have been loaded into the buffer, including the new ones.
230230
* `job :: Union{Job,AbstractString}`: either the job name or a [`Job`](@ref) object.
231-
* `streaming :: Bool`: if set to `true`, the buffer object The streaming can be stopped with
232-
[`interrupt!`](@ref).
231+
* `stream :: Bool`: if set to `true`, the buffer object will automatically pull new logs in a
232+
an asynchronous background task. The streaming can be stopped with [`interrupt!`](@ref).
233233
* `offset :: Integer`: optional non-negative value to specify the starting point of the buffer
234234
235235
# Interface of the returned object
236236
237237
Returns an instance of the abstract [`AbstractJobLogsBuffer`](@ref) type.
238238
These objects contain log messages (of type [`JobLogMessage`](@ref)), but not all the log messages
239-
are immediately available. Instead, at any given time the buffer represents a continous section of
239+
are immediately available. Instead, at any given time the buffer represents a continuous section of
240240
logs that can be extended in either direction.
241241
242242
The following functions can be used to interact with log buffers: [`job_logs_newer!`](@ref),

0 commit comments

Comments
 (0)