8000 DOC : move MEP8 · caspervdw/matplotlib@e07dc2d · GitHub
[go: up one dir, main page]

Skip to content

Commit e07dc2d

Browse files
committed
DOC : move MEP8
1 parent c2cbbc9 commit e07dc2d

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed

doc/devel/MEP/MEP08.rst

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
============
2+
MEP8: PEP8
3+
============
4+
5+
.. contents::
6+
:local:
7+
8+
9+
Status
10+
======
11+
12+
**Discussion**
13+
14+
Branches and Pull requests
15+
==========================
16+
17+
None so far.
18+
19+
Abstract
20+
========
21+
22+
The matplotlib codebase predates PEP8, and therefore is less than
23+
consistent style-wise in some areas. Bringing the codebase into
24+
compliance with PEP8 would go a long way to improving its legibility.
25+
26+
Detailed description
27+
====================
28+
29+
Some files use four space indentation, some use three. Some use
30+
different levels in the same file.
31+
32+
For the most part, class/function/variable naming follows PEP8, but it
33+
wouldn't hurt to fix where necessary.
34+
35+
Implementation
36+
==============
37+
38+
The implementation should be fairly mechanical: running the pep8 tool
39+
over the code and fixing where appropriate.
40+
41+
This should be merged in after the 2.0 release, since the changes will
42+
likely make merging any pending pull requests more difficult.
43+
44+
Additionally, and optionally, PEP8 compliance could be tracked by an
45+
automated build system.
46+
47+
Backward compatibility
48+
======================
49+
50+
Public names of classes and functions that require change (there
51+
shouldn't be many of these) should first be deprecated and then
52+
removed in the next release cycle.
53+
54+
Alternatives
55+
============
56+
57+
PEP8 is a popular standard for Python code style, blessed by the
58+
Python core developers, making any alternatives less desirable.

doc/devel/MEP/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Matplotlib Enhancement Proposals
1313
:maxdepth: 1
1414

1515
template
16+
MEP08
1617
MEP10
1718
MEP11
1819
MEP12

0 commit comments

Comments
 (0)
0