lambdaclass / lambdaclass/lambda_compiler_kit
docs: clarify newline restriction in MatchesSubstring docstring
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Lean
- Sterne
- 2
- Forks
- 1
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Öffne Lck/Regex/Semantics.lean in Zeile 59 und lies den MatchesSubstring-Dokumentationsstring zusammen mit seinem Verhalten im Suchmodus. Füge einen Hinweis hinzu, der erklärt, dass .* keine Zeilenumbrüche matcht, sodass Matches innerhalb einer einzigen Zeile bleiben, und bestätige, dass die Dokumentation Eingaben über mehrere Zeilen hinweg korrekt beschreibt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 58/100