docs gate: the opt-in wording checks stop one of the six sentences that the #2439 documents removed

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

メンテナーはふだん 1 日以内に返信

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
72/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
c, shell

調査の方向性

Start with tools/docs_claims_check.sh and inspect the documents' change in #2439 to retrieve the six sentences and their source files. Extend the self-test to plant each sentence, report how many it examined, and confirm each is rejected with a diagnostic naming its file; run the gate on the current documents as the clean control. Done means all six are caught regardless of line wrapping, while the header states the two patterns it checks and that rewordings can pass.

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

説明

area:gates kind:gate-defect

tools/docs_claims_check.sh has two checks for wording that says argument guards are opt-in (added with the documents of #2439: its self-test cases stale-strict-opt-in and stale-guard-state). An independent review of that change put back, one at a time, each of the six opt-in sentences the change removes, and ran the gate:

  • red: the sentence of docs/SYNTAX.md (says EIGS_STRICT=1 opts into invalid-argument errors; unset already enables guards);
  • green: the sentences of README.md, docs/llms.txt, docs/LANGUAGE_CONTRACT.md, docs/COMPARISON.md and the box of docs/BUILTINS.md.

Why: the first check matches one spelling on one line (the same sentence wrapped over two lines, as docs/LANGUAGE_CONTRACT.md had it, does not match), and the second needs "raises" or "rejects" near "under EIGS_STRICT=1" or "in strict mode", which the removed sentences do not have. Close rewordings pass too ("...raises only when EIGS_STRICT=1 is set", "Argument guards are opt-in: ...").

So a merge or an old branch that brings one of those sentences back is not stopped by the gate. The two self-test cases do go red on what they plant; the gap is what they do not plant.

Done when

  • The six sentences that the documents' change of #2439 removed (take them from that change's diff, by a command) are each refused when put back into the file they came from, by a line that names the file; matching ignores how the sentence is wrapped. The self-test plants all six and prints how many it examined.
  • The check says in its header what it holds (those six sentences, and the two patterns) and that it is not a reader of meaning: a reworded opt-in sentence passes. No sentence of the header claims more.
  • The clean control: the documents as they are pass.

— Claude DevBox

主要言語
C
スター
3
フォーク
7
平均マージ
3時間 28分
マージ済み PR(30日)
270

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

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

InauguralSystems/EigenScript のほかの issue

InauguralSystems/EigenScript の issue をすべて見る

似ている issue

C の issue をもっと見る

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

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