On 06/09/2011 09:45 AM, Benjamin Root wrote: > > > On Tue, Jun 7, 2011 at 5:01 PM, Eric Firing <efir...@hawaii.edu > <mailto:efir...@hawaii.edu>> wrote: > > On 06/07/2011 11:46 AM, Benjamin Root wrote: > > On Saturday, June 4, 2011, Eric Firing<efir...@hawaii.edu > <mailto:efir...@hawaii.edu>> wrote: > >> > >> > >> > > https://github.com/efiring/matplotlib/blob/faq_show_draw/doc/faq/usage_faq.rst > >> > >> Eric, Ben, > >> > >> See if the section "What is interactive mode" makes sense to > you. I have just added it to a feature branch (which includes some > other faq madifications, mainly moving the backend section from > installation to usage), but have not yet generated a pull request. > It doesn't go into every detail, or into the underlying machinery. > It is intended to provide just enough understanding to clear up > user-level confusion about interactive mode, show, and draw, and let > most relatively new users get on with their work. > >> > >> Eric > >> > > > > Eric, > > > > I see where you are going with this, and this is valuable information > > to include in the docs. However, the interactive mode and backend > info > > doesn't seem to fit properly with everything else on the page. I am > > I don't see why not. A FAQ is a place for answers to questions, and > this is the usage section of the FAQ, so I don't see any inherent reason > why information about backends and interactive mode, both of which > involve mpl usage, can't go there. There may be better places, to which > the FAQ could refer, but I think the FAQ is better than nothing. I > moved the backend piece from the installation part of the FAQ, where it > *really* didn't belong. (And the remaining installation part is also an > out-of-date worm jar.) > > > I am looking at doc/faq/installing_faq.rst on your branch, and I can't > tell what is out-of-date (although the Mac part might be, I don't > know). If you are referring to doc/users/installing.rst, that should > have been removed in the big set of commits I made recently when I > merged from v1.0.x-maint to master (the INSTALL file is now used in > master for the installation docs).
Ben, I am referring to doc/faq/installing_faq.rst, and I am mainly concerned about the OS-X section. The version references are clearly out of date; as for the rest, I have no idea what actually works and should be recommended. Attempts have been made elsewhere in mpl to update and clarify the OS-X build and install situation, but I don't think any of that is reflected in this faq section, and I would not be surprised if there are other places in the overall mpl tree where OS-X confusion still lurks. Certainly the mailing list indicates that OS-X installation and building has been a frequent sore point. Although I have built and installed mpl on an OS-X machine, I don't normally use one, and I certainly don't understand all the arcane variables and variations. In OS-X and elsewhere I would also raise the question: does easy-install have a high enough success rate with mpl that it should be included as a reasonable option? Or should its use for mpl be discouraged? I don't know the answer, and have never tried easy-install with mpl, but in general I don't trust it. Too much behind-the-scenes magic. And the users/installing.rst has problems, too, in addition to the general problem of information about building and installing being scattered among the users section, the faq, INSTALL, make.osx, and setup*. Small example: installation requirements are listed under the heading "Build requirements". Progress is going to have to be incremental; I doubt that anyone will have the time to go through the whole system and really clean everything up in one pass. I suggest, if you don't mind, that I go ahead and merge my branch into maint (and from there, master), and then the next increment, whether by you, me, or someone else, can be in a new branch, and the process can be repeated. Eric > > The problem I do see with installation_faq.rst is that the section > titles are not questions, but that is a minor issue here. > > Ben Root > ------------------------------------------------------------------------------ EditLive Enterprise is the world's most technically advanced content authoring tool. Experience the power of Track Changes, Inline Image Editing and ensure content is compliant with Accessibility Checking. http://p.sf.net/sfu/ephox-dev2dev _______________________________________________ Matplotlib-users mailing list Matplotlib-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/matplotlib-users
