leanprover-community / leanprover-community/physlib
TODOs with Line numbers
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 750
- Forks
- 191
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 75
Description
Add the ability to include line numbers within todo items or sections of the Lean code so that people can write to-dos about specific theorems or specific areas of the code. This should work nicely with the website, which would also need updating with this change. It would also be nice to have a shortcut on VS code where you can highlight a given section of text and add a to-do item with respect to that section of text.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating how TODO items or sections are represented in the Lean code, then trace the website rendering and VS Code integration points mentioned in the issue. Define how line references are stored and displayed across those surfaces, and confirm completion when code TODOs, website views, and the editor shortcut all support the requested section references.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- vscode
- Domain
- developer-experience, tooling, web-dev
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100