Enforce ownership and ticketing of TODO notes.
Project description
flake8-todo-ticket
Enforce ownership and ticketing of TODO notes.
This module provides a plugin for flake8
, the Python code checker.
Installation
Install with pip:
pip install flake8-todo-ticket
The plugin officially supports Python >= 3.6
and flake8 >= 3.7
.
You may find other Python 3 versions work as well.
Usage
The plugin finds TODO comments without any indication as to why they exist.
def my_function():
# TODO
# ^ who knows why this is here?
pass
./my_file.py:2:7: T400 Badly formatted TODO. Use TODO(name)[ticket_number]
To remove the error, add some basic information about this TODO:
def my_function():
# TODO(tommilligan)[2856]
# ^ who owns this temporary workaround
# ^ ticket number for this issue
pass
Changelog
0.1.0
Features
- first commit, based on
flake8-fixme
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for flake8_todo_ticket-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1fdb613b0fddfc6bf66bbf85f3aa518b6bb1e8e75dc9fa58beacfd4a83b90c3f |
|
MD5 | c62134d24b5f2ebe52730007b0d4b4a5 |
|
BLAKE2b-256 | 3bfcb79a36b2bc656b9f2d1f9c82f6094454a82b92213d44cd56e8151ea20376 |