Skip to content

Commit

Permalink
[DOC] Improve the docstrings for quit() and exit() (#23309)
Browse files Browse the repository at this point in the history
Fixes #22765
  • Loading branch information
iglpdc authored and fredrikekre committed Aug 22, 2017
1 parent b583df7 commit 3a24cbb
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions base/initdefs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,22 @@ An array of the command line arguments passed to Julia, as strings.
const ARGS = String[]

"""
exit([code])
exit(code=0)
Quit the program with an exit code. The default exit code is zero, indicating that the
program completed successfully (see also [`quit`](@ref)). In an interactive session,
`exit()` can be called with the keyboard shorcut `^D`.
Quit (or control-D at the prompt). The default exit code is zero, indicating that the
processes completed successfully.
"""
exit(n) = ccall(:jl_exit, Void, (Int32,), n)
exit() = exit(0)

"""
quit()
Quit the program indicating that the processes completed successfully. This function calls
`exit(0)` (see [`exit`](@ref)).
Quit the program indicating successful completion. This function is equivalent to
`exit(0)` (see [`exit`](@ref)). In an interactive session, `quit()` can be called
with the keyboard shorcut `^D`.
"""
quit() = exit()

Expand Down

0 comments on commit 3a24cbb

Please sign in to comment.