You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sometimes, example scripts require embedding long URLs, which can violate the line length limit imposed by flake8 and trigger the error E501: line too long.
Potential solutions that are suboptimal:
Attempting to break the URL across multiple lines usually results in the build failing.
A line of code with a URL can be appended with the flag # noqa: E501 to avoid checking line length there. However, the text of this flag also appears in the final generated HTML file, when it shouldn't. For example (image from @raph-luc):
Shortening the URL using a link shortener requires relying on a link shortening service. This could potentially be a security issue since a shortened link obfuscates what its target is, so it would be difficult to tell if it leads to the wrong site, or even to a malicious site.
A solution is needed to allow URLs to be embedded cleanly in example scripts.
Description of the modifications
Sometimes, example scripts require embedding long URLs, which can violate the line length limit imposed by
flake8
and trigger the errorE501: line too long
.Potential solutions that are suboptimal:
# noqa: E501
to avoid checking line length there. However, the text of this flag also appears in the final generated HTML file, when it shouldn't. For example (image from @raph-luc):A solution is needed to allow URLs to be embedded cleanly in example scripts.
Useful links and references
See this conversation for an example: #84 (comment)
The text was updated successfully, but these errors were encountered: