doc comment error message is confusing
Open
Nobody has claimed this yet.
P-low
- Dominant language
- Lean
- Stars
- 9.2k
- Forks
- 990
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 175
Description
Say I do something like
/-- illegal -/
namespace A
end A
That gives error:
unexpected token 'namespace'; expected '#guard_msgs', 'abbrev', 'add_decl_doc', 'axiom', 'binder_predicate', ..
This is a bit confusing, and maybe there should be something mentioning that namespace (and import etc) can't have doc comments on them.
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 reproducing the Lean snippet in the issue and inspect how the parser reports an illegal doc comment before a namespace. Determine the intended diagnostic for namespace and import declarations, then add or update focused parser tests so the resulting message clearly explains that these declarations cannot have doc comments.
Written by the indexing model from the issue text.
Assessment
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100