引数の表とシグネチャが合わない

parameter-table-mismatch既定で動く日本語 / 英語

API リファレンスで、引数の表とシグネチャの引数が食い違う所

例

指摘される文

## measure ```ts measure(text: string, tabSize = 4): number ``` | 引数 | 型 | 説明 | | --- | --- | --- | | `text` | string | 幅を測る行 | | `tabWidth` | number | タブ1つの幅 |

chaff の出力

4:23 「measure」の引数の表とシグネチャで、「tabSize」が片方にしかありません 10:4 「measure」の引数の表とシグネチャで、「tabWidth」が片方にしかありません

直した文

## measure ```ts measure(text: string, tabSize = 4): number ``` | 引数 | 型 | 説明 | | --- | --- | --- | | `text` | string | 幅を測る行 | | `tabSize` | number | タブ1つの幅 |

chaff の出力

指摘なし

この例で使った chaff.yaml

genre: technical/readme

直し方

実際の関数の引数を確かめて、表かシグネチャのどちらかを直してください。

なぜ指摘するのか

API リファレンスで、関数のシグネチャと、その下の引数の表が違う引数を並べていると、読み手はどちらが正しいか分からず、無い引数を渡したり、必要な引数を知らずに終わったりします。引数を足したり名前を変えたりしたときに、片方だけを直すと起きます。コードブロックがちょうど一つの関数を宣言し（function や def、または戻り値の型が付いたもの）、次の見出しかコードブロックより前に、最初の列の見出しが「引数」や「Parameter」の表があるとき、両者を比べます。表にだけある引数は表の行を、シグネチャにだけある引数はシグネチャを指します。

指摘しないもの

関数の呼び出し（wrap(text, 10);）、二つ以上の関数を宣言したコードブロック、分割代入の引数（{ a, b }）、self や this、最初の列の見出しが引数でない表（オプション、項目）、見出しやほかのコードブロックを挟んだ表、行の頭に | の無い表は比べません。型を名前の前に書く宣言（Java の String wrap(String text)）は読みません。表の「options.prefix」は options の項目として読みます。

止める・ゆるめる

この一か所だけ黙らせる（文書に書く）

チームでゆるめる（理由は chaff.yaml にコメントで残ります）

npx chaffjs relax parameter-table-mismatch --why "理由"

チームで止める（chaff.yaml）

rules: parameter-table-mismatch: off

技術的な情報

層: 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

ジャンル

指摘の文

「{function}」の引数の表とシグネチャで、「{name}」が片方にしかありません

このページはルールの定義ファイルから作られています:packages/chaff/rules/parameter-table-mismatch.yaml