8000 DOC : whole bunch of documentation clean up by tacaswell · Pull Request #3170 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

DOC : whole bunch of documentation clean up #3170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 20 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
DOC : minor changes to docs
 - formatting
 - tweaked suggested imports to make copy-paste easier
 - updated list of versions of python
  • Loading branch information
tacaswell committed Jul 18, 2014
commit 6cfccbfa10cc5f16f6093cbff61aa637469615bc
6 changes: 3 additions & 3 deletions doc/devel/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _developers-guide-index:

####################################
The Matplotlib Developers' Guide
####################################
################################
The Matplotlib Developers' Guide
################################

.. htmlonly::

Expand Down
7 changes: 4 additions & 3 deletions doc/devel/portable_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,17 @@ Welcome to the ``__future__``

The top of every `.py` file should include the following::

from __future__ import absolute_import, division, print_function, unicode_literals
from __future__ import (absolute_import, division,
print_function, unicode_literals)
import six

This will make the Python 2 interpreter behave as close to Python 3 as
possible.

All matplotlib files should also import `six`, whether they are using
it or not, just to make moving code between modules easier, as `six`
gets used *a lot*::
gets used *a lot*.

import six

Finding places to use six
^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
13 changes: 10 additions & 3 deletions doc/devel/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,20 @@ a colon, e.g., (this is assuming the test is installed)::

python tests.py matplotlib.tests.test_simplification:test_clipping

If you want to run the full test suite, but want to save wall time try running the
tests in parallel::

python ../matplotlib/tests.py -sv --processes=5 --process-timeout=300

as we do on Travis.ci.


An alternative implementation that does not look at command line
arguments works from within Python::

import matplotlib
matplotlib.test()


.. _`nosetest arguments`: http://somethingaboutorange.com/mrl/projects/nose/1.0.0/usage.html


Expand Down Expand Up @@ -185,8 +192,8 @@ multiple Python environments, including multiple versions of Python
(e.g., 2.6, 2.7, 3.2, etc.) and even different Python implementations
altogether (e.g., CPython, PyPy, Jython, etc.)

Testing all 4 versions of Python (2.6, 2.7, 3.1, and 3.2) requires
having four versions of Python installed on your system and on the
Testing all versions of Python (2.6, 2.7, 3.*) requires
having multiple versions of Python installed on your system and on the
PATH. Depending on your operating system, you may want to use your
package manager (such as apt-get, yum or MacPorts) to do this, or use
`pythonbrew <https://github.com/utahta/pythonbrew>`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had never heard of pythonbrew, so I looked it up--and found that it is deprecated in favor of pyenv.

Expand Down
0