Configuration docs refresh #4492
Merged
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
Conflicts: docs/source/config/index.rst
| ipython --help | ||
| ipython notebook --help | ||
| # etc. | ||
|
|
There was a problem hiding this comment.
One word on precedence of CL options over config files ?
|
+1 |
| \\w {cwd} current working directory | ||
| \\W {cwd_last} basename of CWD | ||
| \\Xn {cwd_x[n]} Show the last n terms of the CWD. n=0 means show all. | ||
| \\Yn {cwd_y[n]} Like \Xn, but show '~' for $HOME |
There was a problem hiding this comment.
It was, yes. I've made it all spaces now.
|
Looks great, thanks! |
minrk
added a commit
that referenced
this pull request
Nov 7, 2013
Configuration docs refresh - Moved the technical details of the config system into the development directory. - Added a new 'intro' document describing how to use the config system, without the technical info. - Autogenerate lists of config options for the main components (this doesn't yet include the parallel machinery). - Condense and tidy up other config docs, removing outdated information.
mattvonrocketstein
pushed a commit
to mattvonrocketstein/ipython
that referenced
this pull request
Nov 3, 2014
Configuration docs refresh - Moved the technical details of the config system into the development directory. - Added a new 'intro' document describing how to use the config system, without the technical info. - Autogenerate lists of config options for the main components (this doesn't yet include the parallel machinery). - Condense and tidy up other config docs, removing outdated information.
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 @minrk pointed out in #4475, our config docs said a lot about how the config system worked, and not enough about how to use it. Here, I have: