docs: Improve discoverability of atreplinit (mention it in Manual>"Command-line Interface">"Startup file")
#44103
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tfiers
added a commit
to tfiers/dotfiles
that referenced
this pull request
Feb 10, 2022
tfiers
force-pushed
the
docs-startup-atreplinit
branch
from
7fe5b10
to
dffefee
Compare
The page covers more than just the options (namely also startup.jl). Info: only other ref to `(@id command-line-options)` is in https://github.com/JuliaLang/julia/blob/93a5f6/stdlib/InteractiveUtils/docs/src/index.md#L3-L4 It now points to a more precise location.
KristofferC
force-pushed
the
docs-startup-atreplinit
branch
from
dffefee
to
b5ee599
Compare
KristofferC
added
the
status:merge me
giordano
removed
the
status:merge me
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As @StefanKarpinski said here, "startup files should probably only be for REPL convenience".
However, the manual makes no mention of
atreplinit, which is the sanctioned way to achieve this.I personally discovered
atreplinitway too late1. In the linked PR, @clarkevans had a similar experience, and suggested to mentionatreplinitin thestartup.jlsection of the manual.Which is what this PR does (first commit).
I made two additional, related improvements to the page in question (next two commits):
Add two missing headers, "Parallel mode" and "Startup file".
These now sit along "Using arguments inside scripts" and "Command-line switches for Julia", which were recently introduced:
Manual: Move introduction about command line arguments from "Getting Started" to "Command-line options" #42878
Rename the page from "Command-line Options" to "Command-line Interface",
to reflect the fact that it describes not only command line options.
Footnotes
Namely only after creating a stop-gap solution for running the contents of
startup.jlin the REPL only, using command line aliases and a custom env var. ↩