Final documentation polish for v1.1.0 release #427
Conversation
Also fixed an error with stem() docs.
| to the philosphy of giving users complete control over the placement of | ||
| plot elements, a :mod:`~matplotlib.tight_layout` module was created to | ||
| address the most common layout issues. | ||
|
|
There was a problem hiding this comment.
You should provide one or more links to example code using the animation API
|
Thanks a lot for doing this -- this is a significant chunk of work that goes into each release and I'm glad you squeezed it out before the baby :-) Normally, I like to include copious links to example code as well as inline graphics in the what's new, since that is what users will be looking for. I've suggested some areas for inline links to examples, and a few choice graphics would round out this pull request. |
|
Just as an additional note, in case I don't get around to it, we should also mention that this will be the last matplotlib to support python 2.4 (are we still planning to support 2.5?). |
|
I added animation.py, legend.py and tight_layout.py to the API list. While they are certainly not up to the documentation standards, there are a couple of reasons to do this. First, if the module does not have an API page, then referencing it via :mod: doesn't work. Second, the animation.py documentation is completely lacking and so an API page can at least present some level of documentation, while tight_layout and legend were actually somewhat complete. @leejjoon, I made some edits to the documentation within legend.py. There are still some more things to do. I have to figure out how to get :mod: for mplot3d to link up, as well as create an example demonstrating the offset labels in mplot3d. The ipython information needs to be made more complete. Lastly, we have a bunch of API changes/additions to mention in the API changes page. |
|
On which python to support after 1.1, perhaps we should support python2.7 and later to ease the integration of the python3 branch. |
|
2.7 is kind of a big jump. My rule of thumb is to use whichever version RHEL is using (which is 2.5 right now). Now, who knows what RHEL will be supporting by the time we do our next release, so it might not be that bad. Therefore, if we were to target 2.7 next, then I think we need to promise LTS for v1.1. |
|
Python 2.6 or later is sufficient to support 3.x. However 2.5 is just too difficult to support in conjunction with 3.x -- that is what is holding us back from merging the py3 branch. I think we can support bugfixes on a 1.1.x branch for some time even as master drops Python 2.5 compatibility, though. |
|
Python 2.6 might be a good compromise. That version does allow for the new exception syntax, 'with' clauses, ternary statements, new string formatting, and class decorators (which might be very useful). |
Final documentation polish for v1.1.0 release
|
Could you please add the following to "other enhancements" (mpl 1.1.0) in doc/users/whats_new.rst ?
|
|
It's in a new branch I'm working on after committing Ben's branch. |
|
Building docs fails on me. The "what's new" page refers "mpl_examples/mplot3d/offset_demo.py" but this does not seems to be version controlled. |
|
My bad... I forgot to add that file to my commit. How do we want to fix this? |
|
On 08/28/2011 07:35 PM, WeatherGod wrote:
|
|
Done! |
documentation follow-up to #427, moving towards v1.1 release
Just in case I am no longer able to work on the documentation any further over the next few weeks (on baby watch right now), here is my work so far.
Most of the focus is on the what's new page. There are still some ReST errors I haven't figured out (mostly with respect to referencing modules). Some of the descriptions could be expanded. Please check what I have written to make sure that I did not over-simplify some of the summaries (particularly the ipython compatibility paragraph).
Another page that might warrant updates is the API changes page: http://matplotlib.sourceforge.net/api/api_changes.html
Also, who did the tight_layout module?