Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Improve the docstrings for quit() and exit() #23309

Merged
merged 1 commit into from
Aug 22, 2017
Merged

[DOC] Improve the docstrings for quit() and exit() #23309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions base/initdefs.jl
View file
Open in desktop
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