header-comments (ODOO026)

Preview (since 0.16.2.2) · Related issues · View source

Derived from the odoo linter.

Fix is always available.

This rule is unstable and in preview. The --preview flag is required for use.

What it does

Checks for stray comments before the first line of code in a file.

Why is this bad?

A comment at the very top of a file that isn't a shebang, encoding declaration, or a directive for a specific tool (pylint, flake8, noqa, isort, fmt, ...) is usually leftover clutter (e.g. a commented-out license header from a template).

Example

# TODO: remove this file
import os

Use instead:

import os