Summary

Fixed a ton of PEP-8 issues in the docs.

Review Request #6639 — Created Nov. 24, 2014 and submitted Nov. 30, 2014, 3:01 p.m.

Information

Owner

justy777

Repository

Review Board

Branch

master

Bugs

Depends On

Commit

eb586c5...

Reviewers

Groups

reviewboard, students

People

Description

Fixed the following PEP-8 issues:

docs/codebase/conf.py:6:80: E501 line too long (80 > 79 characters)

docs/codebase/conf.py:9:80: E501 line too long (82 > 79 characters)

docs/codebase/conf.py:17:11: E401 multiple imports on one line

docs/codebase/conf.py:37:80: E501 line too long (80 > 79 characters)

docs/codebase/conf.py:39:80: E501 line too long (83 > 79 characters)

docs/codebase/conf.py:83:80: E501 line too long (80 > 79 characters)

docs/codebase/conf.py:179:80: E501 line too long (81 > 79 characters)

docs/manual/conf.py:6:80: E501 line too long (80 > 79 characters)

docs/manual/conf.py:9:80: E501 line too long (82 > 79 characters)

docs/manual/conf.py:45:80: E501 line too long (80 > 79 characters)

docs/manual/conf.py:99:80: E501 line too long (80 > 79 characters)

docs/manual/conf.py:197:80: E501 line too long (81 > 79 characters)

docs/manual/_ext/webapidocs.py:383:24: E126 continuation line over-indented for hanging indent

docs/manual/_ext/webapidocs.py:660:80: E501 line too long (80 > 79 characters)

docs/manual/_ext/webapidocs.py:866:1: E302 expected 2 blank lines, found 1

docs/manual/_ext/webapidocs.py:894:1: E302 expected 2 blank lines, found 1

docs/releasenotes/conf.py:6:80: E501 line too long (80 > 79 characters)

docs/releasenotes/conf.py:9:80: E501 line too long (82 > 79 characters)

docs/releasenotes/conf.py:38:80: E501 line too long (80 > 79 characters)

docs/releasenotes/conf.py:85:80: E501 line too long (80 > 79 characters)

docs/releasenotes/conf.py:183:80: E501 line too long (81 > 79 characters)

docs/releasenotes/_ext/extralinks.py:28:30: E713 test for membership should be 'not in'

Testing Done

Built docs, and pep8.

Issues

Description	From	Last Updated
Swap these. Alphabtical order.	chipx86	Nov. 24, 2014, 5:59 p.m.
Despite what the tool says, the lack of a space on these is correct. That's because it's not a comment, …	chipx86	Nov. 24, 2014, 5:59 p.m.
Can you instead put the whole expression in parens, and remove the backslash? Then the expressions can align.	chipx86	Nov. 24, 2014, 6:13 p.m.
Same with these.	chipx86	Nov. 24, 2014, 6:13 p.m.
Same comments as above for this file.	chipx86	Nov. 24, 2014, 6:13 p.m.

Tool: Pyflakes
Processed Files:
    docs/releasenotes/_ext/extralinks.py
    docs/manual/conf.py
    docs/manual/_ext/webapidocs.py
    docs/codebase/conf.py
    docs/releasenotes/conf.py



Tool: PEP8 Style Checker
Processed Files:
    docs/releasenotes/_ext/extralinks.py
    docs/manual/conf.py
    docs/manual/_ext/webapidocs.py
    docs/codebase/conf.py
    docs/releasenotes/conf.py

docs/codebase/conf.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Swap these. Alphabtical order.
```

docs/codebase/conf.py (Diff revision 1)

The issue has been resolved. Show all issues

Despite what the tool says, the lack of a space on these is correct. That's because it's not a comment, but rather a commented-out line.

docs/manual/_ext/webapidocs.py (Diff revision 1)

The issue has been resolved. Show all issues

Can you instead put the whole expression in parens, and remove the backslash? Then the expressions can align.

docs/manual/conf.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Same with these.
```
docs/releasenotes/conf.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Same comments as above for this file.
```

Description:

		Fixed the following PEP-8 issues:
		docs/codebase/conf.py:6:80: E501 line too long (80 > 79 characters)
		docs/codebase/conf.py:9:80: E501 line too long (82 > 79 characters)
		docs/codebase/conf.py:17:11: E401 multiple imports on one line
-		docs/codebase/conf.py:31:1: E265 block comment should start with '# '
		docs/codebase/conf.py:37:80: E501 line too long (80 > 79 characters)
		docs/codebase/conf.py:39:80: E501 line too long (83 > 79 characters)
-		docs/codebase/conf.py:48:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:68:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:72:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:74:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:77:1: E265 block comment should start with '# '
		docs/codebase/conf.py:83:80: E501 line too long (80 > 79 characters)
-		docs/codebase/conf.py:84:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:95:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:111:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:114:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:118:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:123:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:132:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:136:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:139:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:143:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:146:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:149:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:152:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:155:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:160:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:163:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:173:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:176:1: E265 block comment should start with '# '
		docs/codebase/conf.py:179:80: E501 line too long (81 > 79 characters)
-		docs/codebase/conf.py:187:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:191:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:194:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:197:1: E265 block comment should start with '# '
-		docs/codebase/conf.py:200:1: E265 block comment should start with '# '
		docs/manual/conf.py:6:80: E501 line too long (80 > 79 characters)
		docs/manual/conf.py:9:80: E501 line too long (82 > 79 characters)
-		docs/manual/conf.py:39:1: E265 block comment should start with '# '
		docs/manual/conf.py:45:80: E501 line too long (80 > 79 characters)
-		docs/manual/conf.py:64:1: E265 block comment should start with '# '
-		docs/manual/conf.py:84:1: E265 block comment should start with '# '
-		docs/manual/conf.py:88:1: E265 block comment should start with '# '
-		docs/manual/conf.py:90:1: E265 block comment should start with '# '
-		docs/manual/conf.py:93:1: E265 block comment should start with '# '
		docs/manual/conf.py:99:80: E501 line too long (80 > 79 characters)
-		docs/manual/conf.py1: E265 block comment should start with '# '
-		docs/manual/conf.py:111:1: E265 block comment should start with '# '
-		docs/manual/conf.py:132:1: E265 block comment should start with '# '
-		docs/manual/conf.py:136:1: E265 block comment should start with '# '
-		docs/manual/conf.py:141:1: E265 block comment should start with '# '
-		docs/manual/conf.py:150:1: E265 block comment should start with '# '
-		docs/manual/conf.py:154:1: E265 block comment should start with '# '
-		docs/manual/conf.py:157:1: E265 block comment should start with '# '
-		docs/manual/conf.py:161:1: E265 block comment should start with '# '
-		docs/manual/conf.py:164:1: E265 block comment should start with '# '
-		docs/manual/conf.py:167:1: E265 block comment should start with '# '
-		docs/manual/conf.py:170:1: E265 block comment should start with '# '
-		docs/manual/conf.py:178:1: E265 block comment should start with '# '
-		docs/manual/conf.py:181:1: E265 block comment should start with '# '
-		docs/manual/conf.py:191:1: E265 block comment should start with '# '
-		docs/manual/conf.py:194:1: E265 block comment should start with '# '
		docs/manual/conf.py:197:80: E501 line too long (81 > 79 characters)
-		docs/manual/conf.py:207:1: E265 block comment should start with '# '
-		docs/manual/conf.py:211:1: E265 block comment should start with '# '
-		docs/manual/conf.py:214:1: E265 block comment should start with '# '
-		docs/manual/conf.py:217:1: E265 block comment should start with '# '
-		docs/manual/conf.py:220:1: E265 block comment should start with '# '
		docs/manual/_ext/webapidocs.py:383:24: E126 continuation line over-indented for hanging indent
		docs/manual/_ext/webapidocs.py:660:80: E501 line too long (80 > 79 characters)
		docs/manual/_ext/webapidocs.py:866:1: E302 expected 2 blank lines, found 1
		docs/manual/_ext/webapidocs.py:894:1: E302 expected 2 blank lines, found 1
		docs/releasenotes/conf.py:6:80: E501 line too long (80 > 79 characters)
		docs/releasenotes/conf.py:9:80: E501 line too long (82 > 79 characters)
		docs/releasenotes/conf.py:38:80: E501 line too long (80 > 79 characters)
-		docs/releasenotes/conf.py:49:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:70:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:74:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:76:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:79:1: E265 block comment should start with '# '
		docs/releasenotes/conf.py:85:80: E501 line too long (80 > 79 characters)
-		docs/releasenotes/conf.py:86:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:97:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:118:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:122:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:127:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:136:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:140:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:143:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:147:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:150:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:156:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:164:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:167:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:177:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:180:1: E265 block comment should start with '# '
		docs/releasenotes/conf.py:183:80: E501 line too long (81 > 79 characters)
-		docs/releasenotes/conf.py:191:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:195:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:198:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:201:1: E265 block comment should start with '# '
-		docs/releasenotes/conf.py:204:1: E265 block comment should start with '# '
		docs/releasenotes/_ext/extralinks.py:28:30: E713 test for membership should be 'not in'

Commit:

d2b4eb7177a2e4a5be454685147aa22512fc8b0d

eb586c59a220de318181f0b94993841e2d76539d

Diff:

Revision 2 (+41 -24)

Show changes

	docs/codebase/conf.py
	docs/manual/conf.py
	docs/manual/_ext/webapidocs.py
	docs/releasenotes/conf.py
	docs/releasenotes/_ext/extralinks.py

Tool: Pyflakes
Processed Files:
    docs/releasenotes/_ext/extralinks.py
    docs/manual/conf.py
    docs/manual/_ext/webapidocs.py
    docs/codebase/conf.py
    docs/releasenotes/conf.py



Tool: PEP8 Style Checker
Processed Files:
    docs/releasenotes/_ext/extralinks.py
    docs/manual/conf.py
    docs/manual/_ext/webapidocs.py
    docs/codebase/conf.py
    docs/releasenotes/conf.py

Have you tested building the docs?

justy777 Nov. 28, 2014, 11:19 p.m.
```
No, How do I build the docs?
```
justy777 Nov. 30, 2014, 2:27 p.m.
```
make html
```

Testing Done:: ~
Ran unit test, and pep8.
~
Built docs, and pep8.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (79a0526)