lambdaclass / lambdaclass/lambda_compiler_kit
docs: clarify newline restriction in MatchesSubstring docstring
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 2
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Problem
MatchesSubstring in Lck/Regex/Semantics.lean:59 does not document that .* in search mode does not match newlines, meaning MatchesSubstring finds matches within a single line only. Callers reasoning about multi-line inputs could be misled.
Expected fix
Add a note to the MatchesSubstring docstring explaining the newline boundary behaviour and its implication for multi-line inputs.
References
- Flagged by AI code review on PR #9
Contributor guide
No contributing guide indexed for this repository
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
Open Lck/Regex/Semantics.lean at line 59 and read the MatchesSubstring docstring alongside its search-mode behavior. Add a note explaining that .* does not match newlines, so matches remain within a single line, and confirm the documentation accurately describes multi-line inputs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100