Cleaning trace message option names
Open
Nobody has claimed this yet.
help wanted
P-low
- Dominant language
- Lean
- Stars
- 9.2k
- Forks
- 990
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 175
Description
We do not have a consistent naming convention for trace options.
Moreover, most trace messages are mainly for helping developers to debug Lean. We need new messages/options for helping users to diagnose problems by themselves.
Work items:
- A naming convention for option names
- Design new trace for helping users to diagnose problems.
- An API for users traversing/filtering/inspecting trace objects.
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 reviewing the existing trace option names and trace messages, then identify how trace objects are currently represented. Define the naming convention, user-facing diagnostic traces, and traversal, filtering, and inspection API. Done means these three work items have an agreed design and implementation scope.
Written by the indexing model from the issue text.
Assessment
- Domain
- compilers, developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100