Documentation should list variables available in the --format option

[gregnavis]

Currently I'm not able to find a list of variables available for use in the --format option (at least not in the documentation at http://pep8.readthedocs.org/en/latest/). I had to look them up in the source code.

[ilam]

--format=format set the error format [default|pylint|]

pep8 -h

Resolved. This issue can be closed.

[sigmavirus24]

No, the docs still need definition because as I understand it --format takes more than just those two options. I'm pretty sure you can pass it a string which it will then use.

[ilam]

Oh I see. Do you happen to know the format of the string to be passed to the --format option.

[sigmavirus24]

There are a couple examples in the flake8 issue tracker. That should give you an example of a format string you can provide to --format.

[ilam]

I didn't check the flake8, but directly got it from the pep8 source code.

REPORT_FORMAT = {
'default': '%(path)s:%(row)d:%(col)d: %(code)s %(text)s',
'pylint': '%(path)s:%(row)d: [%(code)s] %(text)s',
}

So, the custom format can also be mentioned using the above variable and style. Am I right? If yes, should this be mentioned in the docs?

[sigmavirus24]

This should be referenced in the docs but you should also more thoroughly look for what variables can be interpolated into that string, so far there are 5 (and there may be more):

1. path
2. row
3. col
4. code
5. text

[ilam]

That's right, afaik there are 5, will check for more and confirm the same for inclusion in docs.

[ilam]

Looked into it. It has only 5 variables that can be interpolated into the format structure.
https://github.com/jcrocholl/pep8/blob/master/pep8.py#L1598-L1606

[ilam]

Fixed in #310 . Do comment on the changes. Is there a better way to mention the same?

[IanLee1521]

Resolved with Pull request #310.