Skip to content

Commit af2dd7d

Browse files
authored
Merge pull request #10108 from anntzer/dedent-contributing
Dedent docs in contributing.rst bullet/numbered lists.
2 parents a8ae66e + 9878653 commit af2dd7d

File tree

1 file changed

+72
-77
lines changed

1 file changed

+72
-77
lines changed

doc/devel/contributing.rst

Lines changed: 72 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,26 @@ welcome to post feature requests or pull requests.
1919

2020
If you are reporting a bug, please do your best to include the following:
2121

22-
1. A short, top-level summary of the bug. In most cases, this should be 1-2
23-
sentences.
22+
1. A short, top-level summary of the bug. In most cases, this should be 1-2
23+
sentences.
2424

25-
2. A short, self-contained code snippet to reproduce the bug, ideally allowing
26-
a simple copy and paste to reproduce. Please do your best to reduce the code
27-
snippet to the minimum required.
25+
2. A short, self-contained code snippet to reproduce the bug, ideally allowing
26+
a simple copy and paste to reproduce. Please do your best to reduce the code
27+
snippet to the minimum required.
2828

29-
3. The actual outcome of the code snippet
29+
3. The actual outcome of the code snippet.
3030

31-
4. The expected outcome of the code snippet
31+
4. The expected outcome of the code snippet.
3232

33-
5. The Matplotlib version, Python version and platform that you are using. You
34-
can grab the version with the following commands::
33+
5. The Matplotlib version, Python version and platform that you are using. You
34+
can grab the version with the following commands::
3535

36-
>>> import matplotlib
37-
>>> matplotlib.__version__
38-
'1.5.3'
39-
>>> import platform
40-
>>> platform.python_version()
41-
'2.7.12'
36+
>>> import matplotlib
37+
>>> matplotlib.__version__
38+
'1.5.3'
39+
>>> import platform
40+
>>> platform.python_version()
41+
'2.7.12'
4242

4343
We have preloaded the issue creation page with a Markdown template that you can
4444
use to organize this information.
@@ -175,39 +175,36 @@ documented in the :ref:`development-workflow` section.
175175

176176
A brief overview is:
177177

178-
1. `Create an account <https://github.com/join>`_ on
179-
GitHub if you do not already have one.
178+
1. `Create an account <https://github.com/join>`_ on GitHub if you do not
179+
already have one.
180180

181-
2. Fork the `project repository
182-
<https://github.com/matplotlib/matplotlib>`__: click on the 'Fork' button
183-
near the top of the page. This creates a copy of the code under your
184-
account on the GitHub server.
181+
2. Fork the `project repository <https://github.com/matplotlib/matplotlib>`_:
182+
click on the 'Fork' button near the top of the page. This creates a copy of
183+
the code under your account on the GitHub server.
185184

186-
3. Clone this copy to your local disk::
185+
3. Clone this copy to your local disk::
187186

188-
$ git clone https://github.com/YourLogin/matplotlib.git
187+
$ git clone https://github.com/YourLogin/matplotlib.git
189188

190-
4. Create a branch to hold your changes::
189+
4. Create a branch to hold your changes::
191190

192-
$ git checkout -b my-feature origin/master
191+
$ git checkout -b my-feature origin/master
193192

194-
and start making changes. Never work in the ``master`` branch!
193+
and start making changes. Never work in the ``master`` branch!
195194

196-
5. Work on this copy, on your computer, using Git to do the version
197-
control. When you're done editing e.g., ``lib/matplotlib/collections.py``,
198-
do::
195+
5. Work on this copy, on your computer, using Git to do the version control.
196+
When you're done editing e.g., ``lib/matplotlib/collections.py``, do::
199197

200-
$ git add lib/matplotlib/collections.py
201-
$ git commit
198+
$ git add lib/matplotlib/collections.py
199+
$ git commit
202200

203-
to record your changes in Git, then push them to GitHub with::
201+
to record your changes in Git, then push them to GitHub with::
204202

205-
$ git push -u origin my-feature
203+
$ git push -u origin my-feature
206204

207-
Finally, go to the web page of your fork of the Matplotlib repo,
208-
and click 'Pull request' to send your changes to the maintainers for review.
209-
You may want to consider sending an email to the mailing list for more
210-
visibility.
205+
Finally, go to the web page of your fork of the Matplotlib repo, and click
206+
'Pull request' to send your changes to the maintainers for review. You may
207+
want to consider sending an email to the mailing list for more visibility.
211208

212209
.. seealso::
213210

@@ -221,62 +218,60 @@ Contributing pull requests
221218
It is recommended to check that your contribution complies with the following
222219
rules before submitting a pull request:
223220

224-
* If your pull request addresses an issue, please use the title to describe
225-
the issue and mention the issue number in the pull request description
226-
to ensure a link is created to the original issue.
221+
* If your pull request addresses an issue, please use the title to describe the
222+
issue and mention the issue number in the pull request description to ensure
223+
that a link is created to the original issue.
227224

228-
* All public methods should have informative docstrings with sample
229-
usage when appropriate. Use the
230-
`numpy docstring standard <https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_
225+
* All public methods should have informative docstrings with sample usage when
226+
appropriate. Use the `numpy docstring standard
227+
<https://numpydoc.readthedocs.io/en/latest/format.html>`_.
231228

232-
* Formatting should follow `PEP8 recommendation
233-
<https://www.python.org/dev/peps/pep-0008/>`_. You should consider
234-
installing/enabling automatic PEP8 checking in your editor. Part of the
235-
test suite is checking PEP8 compliance, things go smoother if the code is
236-
mostly PEP8 compliant to begin with.
229+
* Formatting should follow the recommendations of `PEP8
230+
<https://www.python.org/dev/peps/pep-0008/>`__. You should consider
231+
installing/enabling automatic PEP8 checking in your editor. Part of the test
232+
suite is checking PEP8 compliance, things go smoother if the code is mostly
233+
PEP8 compliant to begin with.
237234

238-
* Each high-level plotting function should have a simple example in
239-
the ``Example`` section of the docstring. This should be as simple as
240-
possible to demonstrate the method. More complex examples should go
241-
in the ``examples`` tree.
235+
* Each high-level plotting function should have a simple example in the
236+
``Example`` section of the docstring. This should be as simple as possible
237+
to demonstrate the method. More complex examples should go in the
238+
``examples`` tree.
242239

243-
* Changes (both new features and bugfixes) should be tested. See
244-
:ref:`testing` for more details.
240+
* Changes (both new features and bugfixes) should be tested. See :ref:`testing`
241+
for more details.
245242

246-
* Import the following modules using the standard scipy conventions::
243+
* Import the following modules using the standard scipy conventions::
247244

248-
import numpy as np
249-
import numpy.ma as ma
250-
import matplotlib as mpl
251-
import matplotlib.pyplot as plt
252-
import matplotlib.cbook as cbook
253-
import matplotlib.patches as mpatches
245+
import numpy as np
246+
import numpy.ma as ma
247+
import matplotlib as mpl
248+
import matplotlib.pyplot as plt
249+
import matplotlib.cbook as cbook
250+
import matplotlib.patches as mpatches
254251

255-
* If your change is a major new feature, add an entry to the ``What's new``
256-
section by adding a new file in ``doc/users/whats_new`` (see
257-
:file:`doc/users/whats_new/README` for more information).
252+
* If your change is a major new feature, add an entry to the ``What's new``
253+
section by adding a new file in ``doc/users/next_whats_new`` (see
254+
:file:`doc/users/next_whats_new/README.rst` for more information).
258255

259-
* If you change the API in a backward-incompatible way, please
260-
document it in `doc/api/api_changes`, by adding a new file describing your
261-
changes (see :file:`doc/api/api_changes/README` for more information)
256+
* If you change the API in a backward-incompatible way, please document it in
257+
`doc/api/api_changes`, by adding a new file describing your changes (see
258+
:file:`doc/api/api_changes/README.rst` for more information)
262259

263-
* See below for additional points about
264-
:ref:`keyword-argument-processing`, if code in your pull request
265-
does that.
260+
* See below for additional points about :ref:`keyword-argument-processing`, if
261+
applicable for your pull request.
266262

267263
In addition, you can check for common programming errors with the following
268264
tools:
269265

270-
* Code with a good unittest coverage (at least 70%, better 100%), check
271-
with::
266+
* Code with a good unittest coverage (at least 70%, better 100%), check with::
272267

273-
python -mpip install coverage
274-
python tests.py --with-coverage
268+
python -mpip install coverage
269+
python tests.py --with-coverage
275270

276-
* No pyflakes warnings, check with::
271+
* No pyflakes warnings, check with::
277272

278-
python -mpip install pyflakes
279-
pyflakes path/to/module.py
273+
python -mpip install pyflakes
274+
pyflakes path/to/module.py
280275

281276
.. note::
282277

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy