Opened 3 weeks ago
Closed 3 weeks ago
#37346 closed Cleanup/optimization (wontfix)
PR quality checks do not recognize asterisk task list markers
| Reported by: | Prince Verma | Owned by: | Prince Verma |
|---|---|---|---|
| Component: | Core (Other) | Version: | dev |
| Severity: | Normal | Keywords: | PR, GitHub, checkboxes |
| Cc: | Prince Verma | Triage Stage: | Someday/Maybe |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
The PR quality checker does not recognize checked task list items that use an asterisk (*) instead of a hyphen (-), even though GitHub renders both formats as checked checkboxes.
I encountered this while updating the description of my documentation PR:
https://github.com/django/django/pull/21935
The description used "* [x]" for checked items. GitHub displayed them as checked, but the quality checker reported missing AI disclosure and an incomplete checklist. Replacing the asterisk list markers with hyphens resolved these errors.
Steps to reproduce:
- Start with a PR description that passes the AI disclosure and checklist checks, including exactly one selected AI disclosure option, the required AI usage explanation where applicable, and the first five checklist items checked.
- Replace the leading hyphen list markers in the AI disclosure and Checklist sections with asterisks, preserving the checkbox states and all other content.
- Run the AI disclosure and checklist checks against the modified description.
Expected behavior:
The checks should recognize asterisk task list markers and produce the same results as for equivalent hyphen task list markers.
Actual behavior:
The checks report missing AI disclosure and an incomplete checklist.
The checkbox matching in check_ai_disclosure() and check_checklist() in scripts/pr_quality/check_pr.py currently expects hyphen markers. The filtering of checkbox lines from the AI usage explanation also assumes hyphen markers.
Forum discussion:
https://forum.djangoproject.com/t/pr-quality-checks-reject-checked-items-using-asterisk-list-markers/45990
In that discussion, CodenameTim recommended opening a Trac ticket.
I would be interested in working on a fix with regression tests.
Change History (6)
comment:1 by , 3 weeks ago
| Owner: | set to |
|---|---|
| Status: | new → assigned |
comment:2 by , 3 weeks ago
| Owner: | changed from to |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
| Type: | Bug → Cleanup/optimization |
comment:3 by , 3 weeks ago
| Owner: | changed from to |
|---|
comment:5 by , 3 weeks ago
| Triage Stage: | Accepted → Someday/Maybe |
|---|
Jacob and I discussed this and landed on closing this as a wontfix until we have a better vision for the PR bot.
comment:6 by , 3 weeks ago
| Resolution: | → wontfix |
|---|---|
| Status: | assigned → closed |
Thank you for the ticket
I think as the template uses hyphens, it was reasonable to expect hyphens in the updated template but I understand this would be very confusing. Accepting as a Cleanup/Optimization
Assigning to the reporter as they expressed interest in resolving