8000 Update troubleshooting faq. · matplotlib/matplotlib@10f78c4 · GitHub
[go: up one dir, main page]

Skip to content

Commit 10f78c4

Browse files
committed
Update troubleshooting faq.
Mainly dedent the bullet list, so that it does not appear as a rst blockquote.
1 parent 296befb commit 10f78c4

File tree

1 file changed

+39
-47
lines changed

1 file changed

+39
-47
lines changed

doc/faq/troubleshooting_faq.rst

Lines changed: 39 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -82,63 +82,57 @@ Getting help
8282
There are a number of good resources for getting help with matplotlib.
8383
There is a good chance your question ha 8000 s already been asked:
8484

85-
- The `mailing list archive <http://matplotlib.1069221.n5.nabble.com/>`_.
85+
- The `mailing list archive <http://matplotlib.1069221.n5.nabble.com/>`_.
8686

87-
- `Github issues <https://github.com/matplotlib/matplotlib/issues>`_.
87+
- `Github issues <https://github.com/matplotlib/matplotlib/issues>`_.
8888

89-
- Stackoverflow questions tagged `matplotlib
90-
<http://stackoverflow.com/questions/tagged/matplotlib>`_.
89+
- Stackoverflow questions tagged `matplotlib
90+
<http://stackoverflow.com/questions/tagged/matplotlib>`_.
9191

92-
If you are unable to find an answer to your question through search,
93-
please provide the following information in your e-mail to the
94-
`mailing list
92+
If you are unable to find an answer to your question through search, please
93+
provide the following information in your e-mail to the `mailing list
9594
<https://mail.python.org/mailman/listinfo/matplotlib-users>`_:
9695

97-
* your operating system; (Linux/UNIX users: post the output of ``uname -a``)
96+
* Your operating system (Linux/UNIX users: post the output of ``uname -a``).
9897

99-
* matplotlib version::
98+
* Matplotlib version::
10099

101-
python -c `import matplotlib; print matplotlib.__version__`
100+
python -c "import matplotlib; print matplotlib.__version__"
102101

103-
* where you obtained matplotlib (e.g., your Linux distribution's
104-
packages, github, PyPi, or Anaconda_ or `Enthought Canopy
105-
<https://www.enthought.com/products/canopy/>`_).
102+
* Where you obtained Matplotlib (e.g., your Linux distribution's packages,
103+
Github, PyPi, or `Anaconda <https://www.continuum.io/downloads>`_ or
104+
`Enthought Canopy <https://www.enthought.com/products/canopy/>`_).
106105

107-
.. _Anaconda: https://www.continuum.io/downloads
106+
* Any customizations to your ``matplotlibrc`` file (see
107+
:ref:`sphx_glr_tutorials_introductory_customizing.py`).
108108

109+
* If the problem is reproducible, please try to provide a *minimal*, standalone
110+
Python script that demonstrates the problem. This is *the* critical step.
111+
If you can't post a piece of code that we can run and reproduce your error,
112+
the chances of getting help are significantly diminished. Very often, the
113+
mere act of trying to minimize your code to the smallest bit that produces
114+
the error will help you find a bug in *your* code that is causing the
115+
problem.
109116

110-
* any customizations to your ``matplotlibrc`` file (see
111-
:ref:`sphx_glr_tutorials_introductory_customizing.py`).
117+
* You can get very helpful debugging output from matlotlib by running your
118+
script with a ``verbose-helpful`` or ``--verbose-debug`` flags and posting
119+
the verbose output the lists::
112120

113-
* if the problem is reproducible, please try to provide a *minimal*,
114-
standalone Python script that demonstrates the problem. This is
115-
*the* critical step. If you can't post a piece of code that we
116-
can run and reproduce your error, the chances of getting help are
117-
significantly diminished. Very often, the mere act of trying to
118-
minimize your code to the smallest bit that produces the error
119-
will help you find a bug in *your* code that is causing the
120-
problem.
121+
python simple_plot.py --verbose-helpful > output.txt
121122

122-
* you can get very helpful debugging output from matlotlib by
123-
running your script with a ``verbose-helpful`` or
124-
``--verbose-debug`` flags and posting the verbose output the
125-
lists::
123+
If you compiled Matplotlib yourself, please also provide:
126124

127-
> python simple_plot.py --verbose-helpful > output.txt
125+
* any changes you have made to ``setup.py`` or ``setupext.py``.
126+
* the output of::
128127

129-
If you compiled matplotlib yourself, please also provide
128+
rm -rf build
129+
python setup.py build
130130

131-
* any changes you have made to ``setup.py`` or ``setupext.py``
132-
* the output of::
131+
The beginning of the build output contains lots of details about your
132+
platform that are useful for the Matplotlib developers to diagnose your
133+
problem.
133134

134-
rm -rf build
135-
python setup.py build
136-
137-
The beginning of the build output contains lots of details about your
138-
platform that are useful for the matplotlib developers to diagnose
139-
your problem.
140-
141-
* your compiler version -- e.g., ``gcc --version``
135+
* your compiler version -- e.g., ``gcc --version``.
142136

143137
Including this information in your first e-mail to the mailing list
144138
will save a lot of time.
@@ -149,24 +143,22 @@ tracker only periodically. If your problem has been determined to be
149143
a bug and can not be quickly solved, you may be asked to file a bug in
150144
the tracker so the issue doesn't get lost.
151145

152-
153146
.. _git-trouble:
154147

155148
Problems with recent git versions
156149
=================================
157150

158-
First make sure you have a clean build and install (see
159-
:ref:`clean-install`), get the latest git update, install it and run a
160-
simple test script in debug mode::
151+
First make sure you have a clean build and install (see :ref:`clean-install`),
152+
get the latest git update, install it and run a simple test script in debug
153+
mode::
161154

162-
rm -rf build
163155
rm -rf /path/to/site-packages/matplotlib*
156+
git clean -xdf
164157
git pull
165158
python setup.py install > build.out
166159
python examples/pylab_examples/simple_plot.py --verbose-debug > run.out
167160

168-
and post :file:`build.out` and :file:`run.out` to the
169-
`matplotlib-devel
161+
and post :file:`build.out` and :file:`run.out` to the `matplotlib-devel
170162
<https://mail.python.org/mailman/listinfo/matplotlib-devel>`_
171163
mailing list (please do not post git problems to the `users list
172164
<https://mail.python.org/mailman/listinfo/matplotlib-users>`_).

0 commit comments

Comments
 (0)
0