Add ability to skip long comments about flake8 HOT 5 CLOSED

In GitLab by @sigmavirus24 on Jan 11, 2015, 07:56

So this actually belongs on pep8 because the work to allow long URLs to be skipped was done there and anything like this would need to be implemented there as well.

I'm not going to close this because I'm actually fairly familiar with reST formatted tables (and affordances they allow). I wonder if you could show me the comments in question because I may have suggestions that will allow you to avoid waiting for a new pep8 release to fix this.

from flake8.

In GitLab by @sigmavirus24 on Jan 11, 2015, 10:33

So, let me leave one other thought. If this does end up needing work in pep8, the only way to support ignoring the long-line limit inside comments only will be by splitting out the error code that is currently used so that one covers only comments that are long lines and then you can use --ignore=EXYZ to ignore it project wide.

from flake8.

In GitLab by @harlowja on Jan 11, 2015, 14:41

An example that I sort of had to hack up to get it to pass:

https://review.openstack.org/#/c/146287/2/taskflow/engines/action_engine/engine.py

The options supported there are nice to show in table form:

Generated docs @ http://docs-draft.openstack.org/87/146287/2/check/gate-taskflow-docs/0a66711//doc/build/html/engines.html#taskflow.engines.action_engine.engine.ParallelActionEngine

I had to use the tricky replacement stuff to make some of it fit; which is why I'd be nice to just tell flake8/pep8 to be quiet about long comments (but long lines outside of comments are ok to complain/warn about). If there was such a EXYZ then I'd be using that but it seems there is just long-lines and no differentiation at the current time (so I'd have to turn it off everywhere, which isn't so desirable either).

from flake8.

In GitLab by @sigmavirus24 on Jan 12, 2015, 06:44

Right, so in those cases you can do something like this (and docutils does the right thing in my recollection):

============= =============================
String (case  Executor used
 insensitive)
============= =============================
``process``   :class:`~.executor.
               ParallelProcessTaskExecutor`
============= =============================

It may not be super elegant, but it does work really well. It's a simple way to cheat, especially for doc-strings.

If there was such a EXYZ then I'd be using that

Right. You'll have to ask upstream pep8 to add it. However, this isn't purely for comments. Yes doc-strings can be used for block-commenting, but I've rarely seen them used that way. I'm not sure there will be a good way to add an error code for this that won't be error prone. Still, the proper place to discuss the addition of the error code is upstream.

from flake8.

In GitLab by @sigmavirus24 on Jan 24, 2015, 11:32

Since this relies entirely on changes being made in pep8 and is not specifically a flake8 bug, I'm closing this.

from flake8.