Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Update README.txt for v1.2 #1091

Closed
pelson opened this Issue · 11 comments

5 participants

@pelson
Collaborator

Updated the README.txt to reflect the current state of play.

Additionally, @mdboom can you confirm the version that is planned, is is 1.2 or 2.0?

@mdboom
Owner

I think I'm leaning toward calling it 2.0 to reflect the fact that it supports Python 3.x and underwent a lot of open heart surgery to do so.

@WeatherGod
Collaborator

If it is going to be called 2.0, then there are places in the documentation and docstrings where we have it listed as 1.2 that are going to need to be changed. I am leaning towards 1.2 because there wasn't anything fundamentally changed. If you wrote code targeting mpl 1.0.1, then you can be fairly certain that it will work for master (for the most part). Most of the work in master are bugfixes, enhancements and new features.

@mdboom
Owner

Those are reasonable arguments -- the API is, on the whole, stable between 1.1.x and "next". I'd be willing to back down on this if the consensus is to go with 1.2.

@efiring
Owner

I agree with Ben, and consider 1.2 appropriate--not that it matters greatly.

@pelson
Collaborator

There is much less interface change than I would expect between a 1 and a 2 series, but then, as @efiring says: it doesn't matter much. Just look at firefox (which is now on version 13).

Are we agreeing to stick to 1.2?

@mdboom
Owner

I think the consensus is 1.2. I've created a v1.2.x milestone for the issue tracker, and I will move everything currently on the v2.0.x one to v1.2.x. (There doesn't appear to be a way to "rename" a milestone.)

@mdboom
Owner

I've also thought that having the OS-X-specific instructions in README.txt isn't the greatest. Maybe we should also rename the file to README.OSX.txt (or some such)?

@pelson
Collaborator

Personally, I would sooner see it in the INSTALL file.

@pelson
Collaborator

ipython's 0.13 announcement included some nice statistics re contributors, PRs, commits etc., if we wanted to get hold of this kind of information I'm sure fperez would be happy to share some code/advice.

@mdboom
Owner

The ipython stats are nice. I've asked Fernando if he has any pointers. I'd like to include that. Probably somewhere in the doc tree rather than the README, however.

@NelleV
Collaborator

I don't know if anyone is working on this issue right now. When I first cloned matplotlib, I was very confused by the first line of the README matplotlib for MacOS X 10.3.9 or later and Python 2.5 and Python 2.6. I thought I had dowloaded something specific for macosx. I think the first line should contain the name of the project.
Also, matplotlib doesn't support python2.5 anymore.

As a user, I also like to have the list of the main contributors in order to be able to ask help when contributing or using the module.

@mdboom mdboom closed this issue from a commit
@mdboom mdboom Significantly simplify the way out of date README.txt file. Closes #1091
.

Also updates all of the sourceforge documentation links to matplotlib.org.

Updates the Sourceforge download link to Github.
ede1640
@mdboom mdboom closed this in ede1640
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.