Skip to content

Commit 57637f2

Browse files
committed
Minor docs update
1 parent c37b764 commit 57637f2

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/parse_stream.jl

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,15 @@ end
557557
bump(stream [, flags=EMPTY_FLAGS];
558558
skip_newlines=false, error, remap_kind)
559559
560-
Shift the current token from the input to the output, adding the given flags.
560+
Copy the current token from the input stream to the output. Adds the given
561+
flags to the output token (normally this would be the default `EMPTY_FLAGS` or
562+
`TRIVIA_FLAG`).
563+
564+
Keyword arguments:
565+
* `skip_newlines` - if `true`, newlines are treated as whitespace.
566+
* `error` - if set, emit an error for this token
567+
* `remap_kind` - the kind of the token in the output token stream if it needs
568+
to be modified.
561569
"""
562570
function bump(stream::ParseStream, flags=EMPTY_FLAGS; skip_newlines=false,
563571
error=nothing, remap_kind::Kind=K"None")

0 commit comments

Comments
 (0)