lambdaclass / lambdaclass/lambda_compiler_kit

docs: clarify newline restriction in MatchesSubstring docstring

オープン
#32 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Lean
スター
2
フォーク
1
PR マージ指標
30日以内にマージされた PR はありません

説明

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

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

Lck/Regex/Semantics.lean の59行目を開き、MatchesSubstring の docstring を検索モードでの動作と併せて確認してください。 .* は改行にマッチしないため、マッチは1行内にとどまることを説明する注記を追加し、ドキュメントが複数行入力を正確に記述していることを確認してください。

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
58/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。