Summary

[WIP]ReviewBot PEP257Tool

Review Request #7101 — Created March 22, 2015 and discarded March 31, 2016, 3:03 p.m.

Information

Owner

Caster.Rune

Repository

ReviewBot

Branch

release-0.2.x

Bugs

Depends On

Reviewers

Groups

reviewboard, reviewbot, students

People

brennie

Description

pep257 tool

Testing Done

pip3 install pep257
or
easy_install pep257

Issues

Description	From	Last Updated
Col: 20 E262 inline comment should start with '# '	reviewbot	March 29, 2015, 2:35 a.m.
undefined name 'lnum'	reviewbot	March 29, 2015, 2:35 a.m.
local variable 'lnum' is assigned to but never used	reviewbot	March 29, 2015, 2:35 a.m.
Col: 20 W292 no newline at end of file	reviewbot	March 29, 2015, 2:36 a.m.
Col: 12 E225 missing whitespace around operator	reviewbot	March 29, 2015, 2:36 a.m.
Col: 16 E225 missing whitespace around operator	reviewbot	March 29, 2015, 2:36 a.m.
Blank line between these. This class also needs a docstring.	brennie	March 29, 2015, 2:36 a.m.
These should all have values, I believe.	brennie	March 29, 2015, 2:36 a.m.
Col: 1 W293 blank line contains whitespace	reviewbot	March 29, 2015, 2:36 a.m.
Needs docstring.	brennie	March 29, 2015, 2:36 a.m.
Needs docstring.	brennie	March 29, 2015, 2:36 a.m.
This comment is unnecessary; the code is self explanatory.	brennie	March 29, 2015, 2:36 a.m.
You can format this so it takes fewer lines, e.g. output = execute(['pep257', path], split_lines=True, ignore_errors=True)	brennie	April 17, 2015, 4:28 a.m.
What happens if execution fails? You should maybe specify none_on_ignored_error in the execute call and check if it returns None.	brennie	March 31, 2015, 12:08 a.m.
This needs some work. I assume that a line will not start with the special ' ' string the first …	brennie	March 30, 2015, 11:56 p.m.
This is a weird string and we should document it.	brennie	March 30, 2015, 11:56 p.m.
undefined name 'lnum'	reviewbot	March 29, 2015, 2:36 a.m.
Left over from debugging?	brennie	March 29, 2015, 2:47 a.m.
undefined name 'level'	reviewbot	March 29, 2015, 2:36 a.m.
undefined name 'level'	reviewbot	March 29, 2015, 2:36 a.m.
undefined name 'lnum'	reviewbot	March 29, 2015, 2:36 a.m.
local variable 'lnum' is assigned to but never used	reviewbot	March 29, 2015, 2:36 a.m.
Is this the line number? if so, can we rename this to line_number ? Also, this line number needs to …	brennie	March 30, 2015, 11:56 p.m.
local variable 'level' is assigned to but never used	reviewbot	March 29, 2015, 2:36 a.m.
What is level?	brennie	March 30, 2015, 11:56 p.m.
Col: 20 W292 no newline at end of file	reviewbot	March 29, 2015, 2:36 a.m.
Col: 13 E126 continuation line over-indented for hanging indent	reviewbot	March 30, 2015, 9:47 p.m.
Col: 13 E122 continuation line missing indentation or outdented	reviewbot	March 30, 2015, 9:47 p.m.
Col: 13 E122 continuation line missing indentation or outdented	reviewbot	March 30, 2015, 9:48 p.m.
Col: 13 E122 continuation line missing indentation or outdented	reviewbot	March 30, 2015, 9:48 p.m.
Col: 13 E122 continuation line missing indentation or outdented	reviewbot	March 30, 2015, 9:48 p.m.
Col: 9 E122 continuation line missing indentation or outdented	reviewbot	March 30, 2015, 9:48 p.m.
Col: 10 E231 missing whitespace after ','	reviewbot	March 30, 2015, 9:48 p.m.
Col: 1 W293 blank line contains whitespace	reviewbot	March 30, 2015, 9:49 p.m.
undefined name 'lnum'	reviewbot	March 30, 2015, 9:49 p.m.
undefined name 'level'	reviewbot	March 30, 2015, 9:49 p.m.
local variable 'lnum' is assigned to but never used	reviewbot	March 30, 2015, 9:49 p.m.
local variable 'level' is assigned to but never used	reviewbot	March 30, 2015, 9:49 p.m.
Col: 20 W292 no newline at end of file	reviewbot	March 30, 2015, 9:49 p.m.
Col: 13 E126 continuation line over-indented for hanging indent	reviewbot	March 30, 2015, 9:46 p.m.
Col: 13 E122 continuation line missing indentation or outdented	reviewbot	March 30, 2015, 9:46 p.m.
Col: 13 E122 continuation line missing indentation or outdented	reviewbot	March 30, 2015, 9:46 p.m.
Col: 13 E122 continuation line missing indentation or outdented	reviewbot	March 30, 2015, 9:46 p.m.
Col: 13 E122 continuation line missing indentation or outdented	reviewbot	March 30, 2015, 9:46 p.m.
Col: 9 E122 continuation line missing indentation or outdented	reviewbot	March 30, 2015, 9:46 p.m.
Col: 10 E231 missing whitespace after ','	reviewbot	March 30, 2015, 9:47 p.m.
Col: 1 W293 blank line contains whitespace	reviewbot	March 30, 2015, 9:47 p.m.
Col: 20 W292 no newline at end of file	reviewbot	March 30, 2015, 9:47 p.m.
Col: 80 E501 line too long (112 > 79 characters)	reviewbot	April 11, 2015, 1:55 a.m.
This file should not be in the diff.	brennie	April 21, 2015, 6:17 a.m.
Can this be formatted like: options = [ { 'name': 'ignore', # ... 'field_options': { 'label': 'Ignore', # ... }, …	brennie	April 11, 2015, 1:07 a.m.
Docstrings should be of the form """Single line summary. Multi-line description. """	brennie	April 11, 2015, 1:07 a.m.
Col: 80 E501 line too long (112 > 79 characters)	reviewbot	April 11, 2015, 1:55 a.m.
Docstrings should be of the form """Single line summary. Multi-line description. """	brennie	April 11, 2015, 1:07 a.m.
We don't really use :param foo: in the codebase.	brennie	April 11, 2015, 1:07 a.m.
Blank line between these.	brennie	April 11, 2015, 1:07 a.m.
Blank line between these.	brennie	April 11, 2015, 1:07 a.m.
Since you're returning True in either case, you can do ```python if output: for line in output: # ... return …	brennie	April 11, 2015, 1:07 a.m.
Col: 80 E501 line too long (103 > 79 characters)	reviewbot	April 11, 2015, 1:07 a.m.
Again, can you make ' ' * 8 a constant on the class? You can document it there.	brennie	April 21, 2015, 4:30 a.m.
Col: 80 E501 line too long (81 > 79 characters)	reviewbot	April 11, 2015, 1:55 a.m.
Is the code helpful?	brennie	April 17, 2015, 4:25 a.m.
Col: 29 E131 continuation line unaligned for hanging indent	reviewbot	April 11, 2015, 1:53 a.m.
Col: 80 E501 line too long (104 > 79 characters)	reviewbot	April 11, 2015, 1:52 a.m.
Col: 80 E501 line too long (86 > 79 characters)	reviewbot	April 11, 2015, 1:52 a.m.
Col: 80 E501 line too long (81 > 79 characters)	reviewbot	April 11, 2015, 1:52 a.m.
Col: 29 E131 continuation line unaligned for hanging indent	reviewbot	April 11, 2015, 1:54 a.m.
Col: 1 E302 expected 2 blank lines, found 1	reviewbot	April 11, 2015, 11:15 p.m.
Col: 80 E501 line too long (80 > 79 characters)	reviewbot	April 11, 2015, 11:15 p.m.
Col: 1 E302 expected 2 blank lines, found 1	reviewbot	April 11, 2015, 11:46 p.m.
Col: 80 E501 line too long (80 > 79 characters)	reviewbot	April 11, 2015, 11:46 p.m.
This needs a better docstring.	brennie	April 21, 2015, 4:30 a.m.
Single quotes for strings.	brennie	April 21, 2015, 4:30 a.m.
Docstrings should be of the format: """Single line summary. Multi-line description. """	brennie	April 21, 2015, 4:30 a.m.
Docstrings should be of the format: """Single line summary. Multi-line description. """	brennie	April 21, 2015, 4:30 a.m.
Blank line between block and statement.	brennie	April 21, 2015, 4:30 a.m.
Blank line between statement and block.	brennie	April 21, 2015, 4:30 a.m.
Blank line between block and statement.	brennie	April 21, 2015, 4:30 a.m.
This should be on the class (with the comment before it). See issue in my previous review.	brennie	April 21, 2015, 4:30 a.m.
Blank line between these.	brennie	April 21, 2015, 4:30 a.m.
I'd prefer len(msg_start) over just 8 here.	brennie	April 21, 2015, 4:30 a.m.
Why not code, msg = line[len(msg_start):].split(':', 1)	brennie	April 21, 2015, 4:30 a.m.
Blank line between end of block and a statement.	brennie	April 21, 2015, 4:30 a.m.
Col: 5 E301 expected 1 blank line, found 0	reviewbot	April 21, 2015, 4:30 a.m.
This isn't really a model.	brennie	April 21, 2015, 6:21 a.m.
Blank line between paragraphs in docstrings.	brennie	April 21, 2015, 6:21 a.m.
"Review Bot" "interface to"	brennie	April 21, 2015, 6:21 a.m.
This should go before the _MSG_START constant. Also, make sure to use proper capitalization and ensure that it ends with …	brennie	April 21, 2015, 6:21 a.m.
Col: 5 E301 expected 1 blank line, found 0	reviewbot	April 21, 2015, 4:32 a.m.
Blank line between statement and block.	brennie	April 21, 2015, 6:21 a.m.
You should maybe comment on the format of the output of pep257. You can just put an example of the …	brennie	April 21, 2015, 6:21 a.m.

Tool: Pyflakes
Processed Files:
    bot/reviewbot/tools/pep257.py
    bot/reviewbot/tools/pep8.py



Tool: PEP8 Style Checker
Processed Files:
    bot/reviewbot/tools/pep257.py
    bot/reviewbot/tools/pep8.py

bot/reviewbot/tools/pep257.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 20
 E262 inline comment should start with '# '
```
bot/reviewbot/tools/pep257.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 undefined name 'lnum'
```
bot/reviewbot/tools/pep257.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 local variable 'lnum' is assigned to but never used
```
bot/reviewbot/tools/pep257.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 20
 W292 no newline at end of file
```
bot/reviewbot/tools/pep8.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 12
 E225 missing whitespace around operator
```
bot/reviewbot/tools/pep8.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 16
 E225 missing whitespace around operator
```

Change Summary:

an easy pep257tool without option

Commit:

36fa2997a398dd99a9af81f9be2138e568917928

fd1c1c570c45891afbd1d50b3c91722ed5c10ae9

Diff:

Revision 2 (+45)

Show changes

bot/reviewbot/tools/pep257.py

Tool: PEP8 Style Checker
Processed Files:
    bot/reviewbot/tools/pep257.py



Tool: Pyflakes
Processed Files:
    bot/reviewbot/tools/pep257.py

bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Col: 1
 W293 blank line contains whitespace
```
bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
 undefined name 'lnum'
```
bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
 undefined name 'level'
```
bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
 undefined name 'level'
```
bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
 undefined name 'lnum'
```
bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
 local variable 'lnum' is assigned to but never used
```
bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
 local variable 'level' is assigned to but never used
```
bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Col: 20
 W292 no newline at end of file
```

Fix it!

bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Blank line between these.
This class also needs a docstring.
```
bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
These should all have values, I believe.
```
bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Needs docstring.
```
bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Needs docstring.
```
bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
This comment is unnecessary; the code is self explanatory.
```

bot/reviewbot/tools/pep257.py (Diff revision 2)

An issue was opened. Show all issues

You can format this so it takes fewer lines, e.g.

        output = execute(['pep257', path],
                         split_lines=True,
                         ignore_errors=True)

brennie April 9, 2015, 1:45 a.m.

Please do not mark issues as fixed when they are not fixed.

Caster.Rune April 21, 2015, 4:28 a.m.

this is the previous code. i have change it like:
output = execute(

            [

                'pep257',

                '--ignore=%s' % self.settings['ignore'],

                path

            ],

            split_lines=True,

            ignore_errors=True)

brennie April 21, 2015, 6:13 a.m.

The comments re: formatting still apply. It should then be formatted like so:

        output = execute(['pep257', '--ignore=%s' % self.settings['ignore'],
                          path],
                         split_lines=True,
                         ignore_errors=True)

bot/reviewbot/tools/pep257.py (Diff revision 2)

The issue has been resolved. Show all issues

What happens if execution fails? You should maybe specify none_on_ignored_error in the execute call and check if it returns None.

Caster.Rune March 29, 2015, 3:12 a.m.

if the out put is None. the for loop will not execute. and it will only return True. No comment will post like the pep257 no result if it have no error.

and i wonder what you are asking me to do.

brennie March 30, 2015, 11:47 p.m.

Actually, it appears it will raise an exception:

>>> for _ in None:
...     print('In the loop!')
...
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'NoneType' object is not iterable

bot/reviewbot/tools/pep257.py (Diff revision 2)

The issue has been resolved. Show all issues

This needs some work.
I assume that a line will not start with the special '        ' string the first time and so lnum and level will get set. Is this guaranteed? If not, this needs to be more robust.
However, the static analysis tool doesn't know that. You should set lnum and level to None before the for loop.

bot/reviewbot/tools/pep257.py (Diff revision 2)

The issue has been resolved. Show all issues

This is a weird string and we should document it.

Caster.Rune March 29, 2015, 2:52 a.m.

Sorry, I don't you what you mean.

The PEP257's result is like:

pep257.py:1 at module level:

        D100: Missing docstring in public module

I should use it to differ the error code line and the number line.

brennie March 30, 2015, 11:47 p.m.

I just mean that we should document that this is the start of a line that looks like that.

We should probably just document the format of PEP257's output.

bot/reviewbot/tools/pep257.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Left over from debugging?
```
1. CA
  
  Caster.Rune March 29, 2015, 2:52 a.m.
  forget it...

bot/reviewbot/tools/pep257.py (Diff revision 2)

The issue has been resolved. Show all issues

Is this the line number? if so, can we rename this to line_number ?

Also, this line number needs to be checked to see that is within the changed lines in the diff. We don't want to comment on unchanged lines.

Caster.Rune March 29, 2015, 2:52 a.m.

get it.
the pep8.py is wtitten like it.

bot/reviewbot/tools/pep257.py (Diff revision 2)

The issue has been resolved. Show all issues

What is level?

Caster.Rune March 29, 2015, 2:52 a.m.

the result is like:

pep257.py:1 at module level:

        D100: Missing docstring in public module

i do not konw how to descript at module level
and i can not find the entry point.

what file is the entry point in.

Change Summary:

pep257tool with ignore

Commit:

fd1c1c570c45891afbd1d50b3c91722ed5c10ae9

2b8e857f098446b76127a6b87ad1e745a61da102

Diff:

Revision 3 (+55)

Show changes

bot/reviewbot/tools/pep257.py

Tool: PEP8 Style Checker
Processed Files:
    bot/reviewbot/tools/pep257.py



Tool: Pyflakes
Processed Files:
    bot/reviewbot/tools/pep257.py

bot/reviewbot/tools/pep257.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Col: 13
 E126 continuation line over-indented for hanging indent
```
bot/reviewbot/tools/pep257.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Col: 13
 E122 continuation line missing indentation or outdented
```
bot/reviewbot/tools/pep257.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Col: 13
 E122 continuation line missing indentation or outdented
```
bot/reviewbot/tools/pep257.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Col: 13
 E122 continuation line missing indentation or outdented
```
bot/reviewbot/tools/pep257.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Col: 13
 E122 continuation line missing indentation or outdented
```
bot/reviewbot/tools/pep257.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Col: 9
 E122 continuation line missing indentation or outdented
```
bot/reviewbot/tools/pep257.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Col: 10
 E231 missing whitespace after ','
```
bot/reviewbot/tools/pep257.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Col: 1
 W293 blank line contains whitespace
```
bot/reviewbot/tools/pep257.py (Diff revision 3)
The issue has been resolved. Show all issues
```
 undefined name 'lnum'
```
bot/reviewbot/tools/pep257.py (Diff revision 3)
The issue has been resolved. Show all issues
```
 undefined name 'level'
```
bot/reviewbot/tools/pep257.py (Diff revision 3)
The issue has been resolved. Show all issues
```
 local variable 'lnum' is assigned to but never used
```
bot/reviewbot/tools/pep257.py (Diff revision 3)
The issue has been resolved. Show all issues
```
 local variable 'level' is assigned to but never used
```
bot/reviewbot/tools/pep257.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Col: 20
 W292 no newline at end of file
```

Change Summary:

PEP257 tool

Commit:

2b8e857f098446b76127a6b87ad1e745a61da102

8ba37434483206b60ee9cc37b7a8fd5289dcb914

Diff:

Revision 4 (+69)

Show changes

bot/reviewbot/tools/pep257.py

Tool: Pyflakes
Processed Files:
    bot/reviewbot/tools/pep257.py



Tool: PEP8 Style Checker
Processed Files:
    bot/reviewbot/tools/pep257.py

bot/reviewbot/tools/pep257.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Col: 13
 E126 continuation line over-indented for hanging indent
```
bot/reviewbot/tools/pep257.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Col: 13
 E122 continuation line missing indentation or outdented
```
bot/reviewbot/tools/pep257.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Col: 13
 E122 continuation line missing indentation or outdented
```
bot/reviewbot/tools/pep257.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Col: 13
 E122 continuation line missing indentation or outdented
```
bot/reviewbot/tools/pep257.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Col: 13
 E122 continuation line missing indentation or outdented
```
bot/reviewbot/tools/pep257.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Col: 9
 E122 continuation line missing indentation or outdented
```
bot/reviewbot/tools/pep257.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Col: 10
 E231 missing whitespace after ','
```
bot/reviewbot/tools/pep257.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Col: 1
 W293 blank line contains whitespace
```
bot/reviewbot/tools/pep257.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Col: 20
 W292 no newline at end of file
```

Description:: ~
an easy pep257tool without option
~
pep257 tool

Commit:

8ba37434483206b60ee9cc37b7a8fd5289dcb914

26ee01bf0764c6f9347cdd8c4187f904de59b599

Diff:

Revision 5 (+78)

Show changes

	bot/reviewbot-cookies.txt
	bot/reviewbot/tools/pep257.py

Change Summary:: bug fix
People:: brennie

Commit:

26ee01bf0764c6f9347cdd8c4187f904de59b599

0cc3381701e4fba097920d30978fe542a53e9ba9

Diff:

Revision 6 (+77)

Show changes

	bot/reviewbot-cookies.txt
	bot/setup.py
	bot/reviewbot/tools/pep257.py

Commit:

0cc3381701e4fba097920d30978fe542a53e9ba9

489884ead5341ca69d12eefa8d66273689d142f7

Diff:

Revision 7 (+82)

Show changes

	bot/reviewbot-cookies.txt
	bot/setup.py
	bot/reviewbot/tools/pep257.py

Tool: PEP8 Style Checker
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt



Tool: Pyflakes
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt

bot/reviewbot/tools/pep257.py (Diff revision 7)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (112 > 79 characters)
```

Commit:

489884ead5341ca69d12eefa8d66273689d142f7

facfa505e9a56546e70ed228bf620429e54e0b7d

Diff:

Revision 8 (+85)

Show changes

	bot/reviewbot-cookies.txt
	bot/setup.py
	bot/reviewbot/tools/pep257.py

Tool: Pyflakes
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt



Tool: PEP8 Style Checker
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt

bot/reviewbot/tools/pep257.py (Diff revision 8)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (112 > 79 characters)
```
bot/reviewbot/tools/pep257.py (Diff revision 8)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (103 > 79 characters)
```
bot/reviewbot/tools/pep257.py (Diff revision 8)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (81 > 79 characters)
```

```
Can you add the students review group?
```

bot/reviewbot-cookies.txt (Diff revision 8)

The issue has been resolved. Show all issues

This file should not be in the diff.

CA

Caster.Rune April 11, 2015, 1:07 a.m.
```
get it
```

brennie April 17, 2015, 4:26 a.m.

The file is still in your review request. Please do not mark issues as fixed when they are not fixed.

Caster.Rune April 21, 2015, 4:32 a.m.

i have git rm it from my local repository.how can i delete it from reviewboard?

brennie April 21, 2015, 6:16 a.m.

After you've done git rm you need to make sure to commit your changes.

If that for some reason does not work, you can ask in Slack or run rbt post -X/bot/reviewbot-cookies.txt -r7101 and the file will be excluded from the post.

brennie April 21, 2015, 6:17 a.m.

Ah, I've see you've already fixed this so you can ignore that comment.

bot/reviewbot/tools/pep257.py (Diff revision 8)

The issue has been resolved. Show all issues

Can this be formatted like:

options = [
    {
        'name': 'ignore',
        # ...
        'field_options': {
            'label': 'Ignore',
            # ...
        },
    },
]

bot/reviewbot/tools/pep257.py (Diff revision 8)

The issue has been resolved. Show all issues

Docstrings should be of the form

"""Single line summary.

Multi-line description.
"""

bot/reviewbot/tools/pep257.py (Diff revision 8)

The issue has been resolved. Show all issues

Docstrings should be of the form

"""Single line summary.

Multi-line description.
"""

bot/reviewbot/tools/pep257.py (Diff revision 8)
The issue has been resolved. Show all issues
```
We don't really use :param foo: in the codebase.
```
bot/reviewbot/tools/pep257.py (Diff revision 8)
The issue has been resolved. Show all issues
```
Blank line between these.
```
bot/reviewbot/tools/pep257.py (Diff revision 8)
The issue has been resolved. Show all issues
```
Blank line between these.
```

bot/reviewbot/tools/pep257.py (Diff revision 8)

The issue has been resolved. Show all issues

Since you're returning True in either case, you can do
```python

if output:

    for line in output:

        # ...
return True

 ```

bot/reviewbot/tools/pep257.py (Diff revision 8)

The issue has been resolved. Show all issues

Again, can you make ' ' * 8 a constant on the class? You can document it there.

Caster.Rune April 11, 2015, 1:07 a.m.

sorry, i did not know what's your meaning last time.

brennie April 17, 2015, 4:31 a.m.

Can you make a variable on the class like _MESSAGE_START = ' ' * 8.
By on the class I mean under the class statement and not in a function definition.

bot/reviewbot/tools/pep257.py (Diff revision 8)

The issue has been dropped. Show all issues

Is the code helpful?

Caster.Rune April 11, 2015, 1:07 a.m.

you mean the pep257's warning code?
i think a coder can search the code in the document of pep257, then he can know what should he modify his docstring.

Change Summary:

modify docstring

Commit:

facfa505e9a56546e70ed228bf620429e54e0b7d

3f56dfec05e741c526a7a3dce24ef424d7a8615a

Groups:

students

reviewboard

Diff:

Revision 9 (+79)

Show changes

	bot/reviewbot-cookies.txt
	bot/setup.py
	bot/reviewbot/tools/pep257.py

Tool: PEP8 Style Checker
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt



Tool: Pyflakes
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt

bot/reviewbot/tools/pep257.py (Diff revision 9)
The issue has been resolved. Show all issues
```
Col: 29
 E131 continuation line unaligned for hanging indent
```
bot/reviewbot/tools/pep257.py (Diff revision 9)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (104 > 79 characters)
```
bot/reviewbot/tools/pep257.py (Diff revision 9)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (86 > 79 characters)
```
bot/reviewbot/tools/pep257.py (Diff revision 9)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (81 > 79 characters)
```

Change Summary:

modify too long line

Commit:

3f56dfec05e741c526a7a3dce24ef424d7a8615a

ba79c8f9985acd34c5982a4c52593eadcce207fe

Diff:

Revision 10 (+82)

Show changes

	bot/reviewbot-cookies.txt
	bot/setup.py
	bot/reviewbot/tools/pep257.py

Tool: Pyflakes
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt



Tool: PEP8 Style Checker
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt

bot/reviewbot/tools/pep257.py (Diff revision 10)
The issue has been resolved. Show all issues
```
Col: 29
 E131 continuation line unaligned for hanging indent
```

Change Summary:

align

Commit:

ba79c8f9985acd34c5982a4c52593eadcce207fe

2c0c90f75eb1e9e26d7011208f8fa48faef2a466

Diff:

Revision 11 (+82)

Show changes

	bot/reviewbot-cookies.txt
	bot/setup.py
	bot/reviewbot/tools/pep257.py

Tool: PEP8 Style Checker
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt



Tool: Pyflakes
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt

Diff:

Revision 12 (+169)

Show changes

	bot/reviewbot-cookies.txt
	bot/setup.py
	bot/reviewbot/tools/pep257.py
	bot/reviewbot/tools/shellcheck.py

Tool: PEP8 Style Checker
Processed Files:
    bot/reviewbot/tools/shellcheck.py
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt



Tool: Pyflakes
Processed Files:
    bot/reviewbot/tools/shellcheck.py
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt

bot/reviewbot/tools/shellcheck.py (Diff revision 12)
The issue has been resolved. Show all issues
```
Col: 1
 E302 expected 2 blank lines, found 1
```
bot/reviewbot/tools/shellcheck.py (Diff revision 12)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (80 > 79 characters)
```

Commit:

2c0c90f75eb1e9e26d7011208f8fa48faef2a466

2910dc51af1fb3d23ecf1a80af8a28d1555f2f10

Diff:

Revision 13 (+169)

Show changes

	bot/reviewbot-cookies.txt
	bot/setup.py
	bot/reviewbot/tools/pep257.py
	bot/reviewbot/tools/shellcheck.py

Tool: PEP8 Style Checker
Processed Files:
    bot/reviewbot/tools/shellcheck.py
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt



Tool: Pyflakes
Processed Files:
    bot/reviewbot/tools/shellcheck.py
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt

bot/reviewbot/tools/shellcheck.py (Diff revision 13)
The issue has been resolved. Show all issues
```
Col: 1
 E302 expected 2 blank lines, found 1
```
bot/reviewbot/tools/shellcheck.py (Diff revision 13)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (80 > 79 characters)
```

Commit:

2910dc51af1fb3d23ecf1a80af8a28d1555f2f10

88f4f172bf9a78f81c1dded081aefa969ebce73a

Diff:

Revision 14 (+82)

Show changes

	bot/reviewbot-cookies.txt
	bot/setup.py
	bot/reviewbot/tools/pep257.py

Tool: PEP8 Style Checker
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt



Tool: Pyflakes
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    bot/reviewbot-cookies.txt

Testing Done:: +
pip3 install pep257
+ or
+ easy_install pep257

bot/reviewbot/tools/pep257.py (Diff revision 14)
The issue has been resolved. Show all issues
```
This needs a better docstring.
```
bot/reviewbot/tools/pep257.py (Diff revision 14)
The issue has been resolved. Show all issues
```
Single quotes for strings.
```

bot/reviewbot/tools/pep257.py (Diff revision 14)

The issue has been resolved. Show all issues

Docstrings should be of the format:

"""Single line summary.

Multi-line description.
"""

bot/reviewbot/tools/pep257.py (Diff revision 14)

The issue has been resolved. Show all issues

Docstrings should be of the format:

"""Single line summary.

Multi-line description.
"""

bot/reviewbot/tools/pep257.py (Diff revision 14)
The issue has been resolved. Show all issues
```
Blank line between block and statement.
```
bot/reviewbot/tools/pep257.py (Diff revision 14)
The issue has been resolved. Show all issues
```
Blank line between statement and block.
```
bot/reviewbot/tools/pep257.py (Diff revision 14)
The issue has been resolved. Show all issues
```
Blank line between block and statement.
```

bot/reviewbot/tools/pep257.py (Diff revision 14)

The issue has been resolved. Show all issues

This should be on the class (with the comment before it). See issue in my previous review.

bot/reviewbot/tools/pep257.py (Diff revision 14)
The issue has been resolved. Show all issues
```
Blank line between these.
```
bot/reviewbot/tools/pep257.py (Diff revision 14)
The issue has been resolved. Show all issues
```
I'd prefer len(msg_start) over just 8 here.
```

bot/reviewbot/tools/pep257.py (Diff revision 14)

The issue has been resolved. Show all issues

Why not

code, msg = line[len(msg_start):].split(':', 1)

bot/reviewbot/tools/pep257.py (Diff revision 14)
The issue has been resolved. Show all issues
```
Blank line between end of block and a statement.
```

Commit:

88f4f172bf9a78f81c1dded081aefa969ebce73a

5692c80b52e0f392163fb5c9ccd1c65d85a07234

Diff:

Revision 15 (+94)

Show changes

	.gitignore
	bot/setup.py
	bot/reviewbot/tools/pep257.py

Tool: Pyflakes
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    .gitignore



Tool: PEP8 Style Checker
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    .gitignore

bot/reviewbot/tools/pep257.py (Diff revision 15)
The issue has been resolved. Show all issues
```
Col: 5
 E301 expected 1 blank line, found 0
```

Commit:

5692c80b52e0f392163fb5c9ccd1c65d85a07234

0f6585f2093eed6494edea745b35d7d685c702c8

Diff:

Revision 16 (+93 -4)

Show changes

	.gitignore
	bot/setup.py
	bot/reviewbot/tools/pep257.py

Tool: Pyflakes
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    .gitignore



Tool: PEP8 Style Checker
Processed Files:
    bot/setup.py
    bot/reviewbot/tools/pep257.py

Ignored Files:
    .gitignore

bot/reviewbot/tools/pep257.py (Diff revision 16)
The issue has been resolved. Show all issues
```
Col: 5
 E301 expected 1 blank line, found 0
```

Fix it!

<p>It seems you've accidentally removed the <code>.gitignore</code> from the repository. Please undo this change.</p>

<p>You can undo this by doing <code>git checkout master -- .gitignore</code> and then commiting the change.</p>

bot/reviewbot/tools/pep257.py (Diff revision 16)
An issue was opened. Show all issues
```
This isn't really a model.
```
bot/reviewbot/tools/pep257.py (Diff revision 16)
An issue was opened. Show all issues
```
Blank line between paragraphs in docstrings.
```
bot/reviewbot/tools/pep257.py (Diff revision 16)
An issue was opened. Show all issues
```
"Review Bot"
"interface to"
```

bot/reviewbot/tools/pep257.py (Diff revision 16)

An issue was opened. Show all issues

This should go before the _MSG_START constant.

Also, make sure to use proper capitalization and ensure that it ends with a period.

bot/reviewbot/tools/pep257.py (Diff revision 16)
An issue was opened. Show all issues
```
Blank line between statement and block.
```

bot/reviewbot/tools/pep257.py (Diff revision 16)

An issue was opened. Show all issues

You should maybe comment on the format of the output of pep257. You can just put an example of the output, that would be fine.

Status:: Discarded