Bug: 'unterminated comment' error when you have `/-` in a docstring
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 9.2k
- Forks
- 990
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 175
Description
Prerequisites
Please put an X between the brackets as you perform the following steps:
- Check that your issue is not already filed:
https://github.com/leanprover/lean4/issues - Reduce the issue to a minimal, self-contained, reproducible test case.
Avoid dependencies to Mathlib or Batteries. - Test your test case against the latest nightly release, for example on
https://live.lean-lang.org/#project=lean-nightly
(You can also use the settings there to switch to “Lean nightly”)
Description
Having /- appear in a docstring or block comment seems to be interpreted as starting a nested comment, triggering an unterminated comment error. This error confusingly is only shown at the very end of the file, even if the faulty comment is much higher up.
Furthermore, syntax highlighting in VSCode does show the comment as being properly terminated, making the error very confusing to track down.
/-- `x +/- y` -/
def test : String := "foo"
-- We get `unterminated comment` at the *end* of the file, even if we introduce other definitions after `test`
Context
Steps to Reproduce
- Write a docstring that has
/-in it - Be confused about the 'unterminated comment' error
Expected behavior: [Clear and concise description of what you expect to happen]
Having /- inside a docstring or block comment should not have any special meaning.
At the very least, the 'unterminated comment' error should be located at the faulty comment.
Actual behavior: [Clear and concise description of what actually happens]
Having /- inside a docstring or block comment seems to start a nested comment, that is expected to be terminated by a matching -/. This causes an unterminated comment error at the very end of the file
Versions
live.lean-lang.org version 4.12.0-nightly-2024-08-12
Impact
Add 👍 to issues you consider important. If others are impacted by this issue, please ask them to add 👍 to it.
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 with the minimal Lean reproducer in the issue and compare how docstrings and block comments are parsed when they contain /-. Check both the reported error location and the expected behavior that the sequence should have no special meaning inside a comment; done means the reproducer no longer reports an unterminated comment at end of file.
Written by the indexing model from the issue text.
Assessment
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100