astral-sh/ruff

TD003 error in regex or misleading error message

Open

#16519 opened on Mar 5, 2025

View on GitHub
 (7 comments) (3 reactions) (0 assignees)Rust (47,527 stars) (2,088 forks)batch import
documentationhelp wantedrule

Description

Summary

Rule TD0003 ('Missing issue link for this TODO') allows for 4 different forms off issue link, however only explicit link and #123 works anywhere in the TODO comment, 123 and FOOBAR-1234 have to be put alone in the separate line.

  1. While it may be reasonable for digits alone version I think it would be much more convenient to search for FOOBAR-1234 form in the whole TODO comment.
  2. This difference in behavior is not stated anywhere clearly, nor in the error message neither in ruff docs (it can be only inferred form the examples) which is very confusing for the user.

Version

0.9.3

Contributor guide

Tech stack
rustpython
Domain
clideveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Ruff's TODO rule documentationBasic regex understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the ruff source code for rule TD0003, likely in crates/ruff linter/src/rules/todo.rs or similar. Review the existing regex patterns and error messages. Check the documentation at https://docs.astral.sh/ruff/rules/#TD0003. Discuss in the issue comments (e.g., maintainer feedback) to clarify the intended behavior. Consider updating both the error message and the documentation to clearly state the accepted formats.