説明の版とコードの版が違う
version-mismatch既定で動く日本語 / 英語
コードブロックのすぐ上の説明が名指す版と、コードの版が違う所
例
直し方
説明とコードのどちらが今の版かを確かめて、もう一方を直してください。
なぜ指摘するのか
「2.3.0 を入れます」のすぐ下のコマンドが「tidyq@2.4.0」だと、読み手はどちらを入れればよいか分かりません。新しい版を出したときに、コード例か説明の片方だけを直すと起きます。コードブロックのすぐ上の段落に書いた版（2.3.0 のように点で三つに区切った番号）を、そのコードブロックにある版と比べます。コードに版がちょうど一つあり、段落の版がそれと違うとき指します。コードが redis:7.4 のように名前と版で固定したソフトを、段落が「Redis 7.2」のように名前のすぐ後の版で書いたときは、7.4 のような二つに区切った番号も比べます。7.4 と 7.4.1 のように一方が他方の系列なら同じと見ます。また、変更履歴のように版の見出し（または版で始まる箇条書き）が並ぶ文書では、「npm install wrapkit@3.1.0」のように自分のパッケージ（題名か冒頭の段落が名指すもの）をちょうど一つの版に固定して入れるコマンドを、その版の項の中ならその版と、外なら一覧で最新の版と比べます。
指摘しないもの
版の無いコードブロック、版が二つ以上あるコードブロック（「2.3.0 から 2.4.0 へ」の更新）、範囲の端や起点として書いた版（「2.3.0 から」「20.0.0 以上」）、別のプログラムの名前のすぐ後ろの版（「Node.js 18.17.0 が必要」）、見出しや箇条書きや表の版、版だけの行、ブロックが名前で固定したソフトの名前のすぐ後ろ以外の、二つに区切った番号（22.04、3.1）と、先頭が四桁の番号（2024.01.15）は比べません。インストールのコマンドでは、題名や冒頭の段落が名指さない別のパッケージ（依存するもの）、範囲（^3.0.0、>=3.0.0）、latest のようなタグ、プレリリース（4.0.0-beta.1）の版と、リリースの一覧が無い文書は比べません。一覧の最新はプレリリースを除いて版の順で選びます。
止める・ゆるめる
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- 注意
- 対象の言語
- 日本語と英語
- 向いている文章
- technical, docs, blog, legal, academic, literature, speech
- 文書から読み取るもの
- markdown
強さ（段階）
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます（どのジャンルで動くかは下の「ジャンルごとの動き」にあります）。
| strict | エラー |
|---|---|
| normal | 注意 |
| relaxed | 情報 |
このルールには数える上限がありません。段階は指摘の重さを変えます。relaxed にすると指摘は消えずに一段軽く出ます。
ジャンルごとの動き
- 既定で動くジャンル
- technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, docs/manual, docs/faq, docs/glossary
- このルールを止めるジャンル
- legal/contract, legal/statute, legal/judgment, legal/patent, academic/paper, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
- このルールが向かず、見ないジャンル
- business/proposal, business/report, business/email, business/press-release, business/meeting-notes
指摘の文
「{written}」と書いていますが、すぐ下のコードは {code} です
{pinned} を入れるコマンドですが、この文書のリリースの一覧で最新の版は {release} です
{pinned} を入れるコマンドですが、{release} のリリースの項に書いています
このページはルールの定義ファイルから作られています:packages/chaff/rules/version-mismatch.yaml