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.

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

touch up exit/quit docstrings #22765

Closed
Sacha0 opened this issue Jul 11, 2017 · 0 comments
Closed

touch up exit/quit docstrings #22765

Sacha0 opened this issue Jul 11, 2017 · 0 comments
Labels
domain:docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia Hacktoberfest Good for Hacktoberfest participants needs docs Documentation for this change is required

Comments

@Sacha0
Copy link
Member

Sacha0 commented Jul 11, 2017

As discussed in #22651 (review), the docstrings for exit and quit,

help?> exit
[...]
  exit([code])

  Quit (or control-D at the prompt). The default exit code is zero, indicating that the processes completed successfully.

help?> quit
[...]
  quit()

  Quit the program indicating that the processes completed successfully. This function calls exit(0) (see exit).

might benefit from a wordsmith's attention. Specifically, exit could benefit from a reference to quit, somehow integrating "control-D at the prompt" more gracefully as a synonym could be an improvement, and smoothing out the somewhat-jarring but technically correct use of plural "processes" could also be a step forward. Best!

@Sacha0 Sacha0 added domain:docs This change adds or pertains to documentation Hacktoberfest Good for Hacktoberfest participants good first issue Indicates a good issue for first-time contributors to Julia needs docs Documentation for this change is required labels Jul 11, 2017
iglpdc added a commit to iglpdc/julia that referenced this issue Aug 17, 2017
iglpdc added a commit to iglpdc/julia that referenced this issue Aug 18, 2017
iglpdc added a commit to iglpdc/julia that referenced this issue Aug 21, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia Hacktoberfest Good for Hacktoberfest participants needs docs Documentation for this change is required
Projects
None yet
Development

No branches or pull requests

1 participant