Update README.txt for v1.2 #1091

Closed
pelson opened this Issue Aug 15, 2012 · 11 comments

Comments

Projects
None yet
5 participants
@pelson
Member

pelson commented Aug 15, 2012

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

This comment has been minimized.

Show comment Hide comment
@mdboom

mdboom Aug 15, 2012

Member

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.

Member

mdboom commented Aug 15, 2012

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

This comment has been minimized.

Show comment Hide comment
@WeatherGod

WeatherGod Aug 15, 2012

Member

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.

Member

WeatherGod commented Aug 15, 2012

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

This comment has been minimized.

Show comment Hide comment
@mdboom

mdboom Aug 15, 2012

Member

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.

Member

mdboom commented Aug 15, 2012

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

This comment has been minimized.

Show comment Hide comment
@efiring

efiring Aug 15, 2012

Member

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

Member

efiring commented Aug 15, 2012

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

@pelson

This comment has been minimized.

Show comment Hide comment
@pelson

pelson Aug 16, 2012

Member

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?

Member

pelson commented Aug 16, 2012

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

This comment has been minimized.

Show comment Hide comment
@mdboom

mdboom Aug 16, 2012

Member

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.)

Member

mdboom commented Aug 16, 2012

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

This comment has been minimized.

Show comment Hide comment
@mdboom

mdboom Aug 20, 2012

Member

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)?

Member

mdboom commented Aug 20, 2012

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

This comment has been minimized.

Show comment Hide comment
@pelson

pelson Aug 21, 2012

Member

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

Member

pelson commented Aug 21, 2012

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

@pelson

This comment has been minimized.

Show comment Hide comment
@pelson

pelson Aug 21, 2012

Member

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.

Member

pelson commented Aug 21, 2012

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

This comment has been minimized.

Show comment Hide comment
@mdboom

mdboom Aug 23, 2012

Member

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.

Member

mdboom commented Aug 23, 2012

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

This comment has been minimized.

Show comment Hide comment
@NelleV

NelleV Aug 31, 2012

Contributor

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.

Contributor

NelleV commented Aug 31, 2012

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment