How should I format a long url in a python comment and still be PEP8 compliant

Question

In a block comment, I want to reference a URL that is over 80 characters long. What is the preferred convention for displaying this URL? I know bit.ly is an option, but the URL itself is descriptive. Shortening it and then having a nested comment describing the shortened URL seems like a crappy solution.

Accepted Answer

Don't break the url:

Some other good reasons to ignore a particular guideline:

- When applying the guideline would make the code less readable, even for someone who is used to reading code that follows this PEP. ...

Source:

```
# A Foolish Consistency is the Hobgoblin of Little Minds [1]
# [1]: http://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds
```

You can use the # noqa at the end of the line to stop PEP8/pycodestyle/Flake8 from running that check. Should also avoid warnings in your IDE.

```
# [1]: http://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds # noqa
```

How should I format a long url in a python comment and still be PEP8 compliant

Solution

Problem