Remove references to 0.11 and 0.12 from config/overview.rst #3905
Conversation
| can enable their objects to take advantage of the configuration system | ||
| should consult our :ref:`developer guide <developer_guide>` | ||
| This section describes the IPython configuration system. | ||
|
|
There was a problem hiding this comment.
keep a ..note: here maybe with a link to 0.13.x doc that explain how to migrate. something around "If you are migrating from pre 0.12 version of IPython please have a look at migrating your configurations +link"
There was a problem hiding this comment.
Good idea. What would be the format of the link?
e.g. http://ipython.org/ipython-doc/rel-0.13.2/index.htm ?
This does not currently exist
There was a problem hiding this comment.
You can link to 0.12 for now. http://ipython.org/ipython-doc/rel-0.12.1/config/overview.html
There was a problem hiding this comment.
0.13.2 does exist, you just made a typo (left out 'l')
There was a problem hiding this comment.
On Mon, Aug 5, 2013 at 12:52 PM, Matthias Bussonnier <
notifications@github.com> wrote:
In docs/source/config/overview.rst:
-.. warning::
- If you are upgrading to version 0.11 of IPython, you will need to migrate
- your old :file:
ipythonrcor :file:ipy_user_conf.pyconfiguration files- to the new system. You may want to read the section on
- :ref:
configuring IPython <configuring_ipython>. There are also some ideason the IPython wiki <http://wiki.ipython.org/Cookbook/Moving_config_to_IPython_0.11>_- about this.
-The discussion that follows is focused on teaching users how to configure
-IPython to their liking. Developers who want to know more about how they
-can enable their objects to take advantage of the configuration system
-should consult our :ref:developer guide <developer_guide>
+This section describes the IPython configuration system.
+D'oh
??
—
Reply to this email directly or view it on GitHubhttps://github.com//pull/3905/files#r5585036
.
Dr. David P. Sanders
Profesor Titular "A" / Associate Professor
Departamento de Física, Facultad de Ciencias
Universidad Nacional Autónoma de México (UNAM)
dpsanders@gmail.com
http://sistemas.fciencias.unam.mx/~dsanders
Cubículo / office: #414, 4o. piso del Depto. de Física
Tel.: +52 55 5622 4965
There was a problem hiding this comment.
D'oh
D'oh== I should have seen the typo htm->html , was a response to min's comment.
|
Looks like a sensible cleanup. In any case I think this part of the configuration need a much more User-friendly version which is not targeted at developers. |
|
I completely agree. This is something that I don't know much about (mainly because of the lack of documentation :D). |
Exactly and that's the point. What do you know? what would you like to know ? I'm biased because I know the config system. Try to make a description of that before reading the rest. IMHO it should be pretty strait forward. Basic :
What do you think ? |
|
The following FAQs are what occurred to me. (They seem to me to be much more FAQs than the ones at Imports
Configuration
Appearance
|
Imports :http://ipython.org/ipython-doc/stable/config/overview.html#startup-files configuration
+1
Too complicated for a beginner, you really want to know about MetaHasTrait ?
Answer depend too much on user IMHO. Don't mess with what you don't understand usually work well.
Ah, this one is good.
I think it is the other way around, people don't know usually of the %config magic, and I think that as long as it cannot be persistant it should stay this way.
All this go into Good to see what you think, you might be a little harsh on "horrible font". |
|
"horrible font" isn't appropriate for a FAQ. Note that the default choices are driven mostly by a need to minimize compatibility issues, hence we can't get too creative in picking pretty but not-always-available fonts. |
Of course it's not appropriate for a FAQ, understood as an official document on the IPython website, and I never suggested that it was. In any case, the font has as much to do with the browser as any choice by an IPython developer. I was certainly not intending any disrespect to anybody -- I have voiced several times my admiration for the project, team, and amazing work that I was privileged to witness at first hand a couple of weeks ago (and hope to contribute more substantially to in the future). Rather, I was doing a brainstorming session, as suggested by @Carreau , trying to put myself in the shoes of new users who want to use IPython and make it their own, but don't know how to go about that, and seeing how that could impact on the documentation. What I came up with are indeed FAQ's, in the sense of questions that people do frequently ask themselves, and wish that they had somebody else to ask! This can be the basis of a great FAQ document, in my opinion. |
What do you mean by "persistent" here? |
persistent in the sens you quit qtconsole and come back with the same settings.
I don't consider 'retina' as beeing better figure quality.And why would 'retina' and matplotlib be a special config option that need more care than others ?
But right now we cant modify programmatically a user config file. once this is done we can have something like You should document from the more global to the specific:
Explaining the first is enough for people to survive, if you explain only the second at some point you will have to explain the first to people. So let's explain the first first, and live the second for advance usage. |
|
Merging this as-is, since it is simple cleanup. We can continue the further discussion of the contents of the docs elsewhere. |
Remove stale references to 0.11 and 0.12 from config/overview.rst
Remove stale references to 0.11 and 0.12 from config/overview.rst
Remove ancient references to 0.11 and 0.12 from
config/overview.rst.By the way, I do not see where in
<developer_guide>the information referred to in the first paragraph is.