Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

docs: update the example-fence guide to the current checker grammar

オープン 初心者向け
  • 何か問題がありますか？
#1,240 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
88/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
markdown, python
領域
documentation, testing-qa

調査の方向性

docs/README.md の規約セクションと、tests/test_doc_examples.py の文法を確認してください。一時的な Markdown fixture を作成し、python3 tests/test_doc_examples.py <fixture.md> を実行して、実行される例、フラグメント、理由のある nocheck 免除を検証してください。checker に一致するようにガイドだけを更新し、無効なタグと出力の欠落は引き続きエラーにしてください。

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

説明

area:docs documentation good first issue help wanted kind:docs-drift

The documentation guide teaches two example forms that the current example checker rejects. A first-time documentation contributor following the guide will fail the check.

Evidence

docs/README.md, Conventions in these docs says:

  • eigenscript skip marks a deliberately unexecuted example.
  • Code without an output block is an illustrative fragment.

The checker grammar now requires an output pair for an untagged whole program, fragment with declared free names for a snippet, or nocheck <reason> for an explicit exemption. The old skip spelling was removed.

Executed at b91768e23c5a874a64e76e4af9ab291e6aa49983, using temporary Markdown fixtures and python3 tests/test_doc_examples.py <fixture.md>:

Fixture Result
The documented eigenscript skip form Exit 1: unknown fence tag
An untagged example with no output block Exit 1: output block required
Supported output pair, fragment, and reasoned exemption Exit 0: 2 checked, 2 passed, 1 skipped

PR #1175 introduced the current checker behavior but missed this guide; the active documentation PR #1226 does not change docs/README.md.

First-contribution scope

Update only the conventions section to teach the existing supported forms. Explain that untagged runnable examples need output, fragments declare their free variables, and nocheck requires a reason on the fence's opening line. Link to the checker for the full grammar. This needs Markdown familiarity, not runtime expertise.

Done when

  • The guide no longer recommends skip or silently exempting outputless examples.
  • Verify all three supported forms in one small temporary Markdown fixture containing at least one executed example. The checker must accept the forms; a fixture containing only nocheck is rejected for executing zero checks.
  • Invalid/unknown tags and missing output remain errors; do not weaken or edit the checker to match the old guide.
  • The PR records the focused checker command and its results.
主要言語
C
スター
3
フォーク
7
平均マージ
3時間 58分
マージ済み PR（30日）
105

環境構築

Codespaces で開く

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

はじめの一歩

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

InauguralSystems/EigenScript のほかの issue

InauguralSystems/EigenScript の issue をすべて見る

似ている issue

C の issue をもっと見る

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

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