search

cpprefjp / site

cpprefjpサイトのMarkdownソース
https://cpprefjp.github.io/
381 stars 155 forks source link

Fix typo #1226

Closed Joseph0304 closed 9 months ago

Joseph0304 commented 9 months ago

先日のtypo修正に続き、他でtypoがないかチェックしてみました。

以下の方法で検出しています。 typosをinstallし、以下の設定を加えた状態で$ typosを実行。

[default]
extend-ignore-identifiers-re = [
    "^[0-9a-fA-F]+",
    "inout_ptr",
    "BRE_FRA",
    "THA_THA",
    "^[0-9a-fA-F]+",
    "ND",
    "UsefullCode",
    "referencable",
    "unexpect_t",
    "unexpect",
]

[files]
extend-exclude = [
    "start_editing/contribution_stats_2023.md",
    "reference/string/basic_string/**/*.md",
    "reference/string_view/basic_string_view/**/*.md",
]

また出力結果にconst param_type& parmといった内容が散見されましたが、

error: `parm` should be `param`, `pram`, `parma`
  --> .\reference\random\cauchy_distribution\param.md:10:30
   |
10 | void param(const param_type& parm); // (2)
   |                              ^^^^
   |

こういったパターンもあるので、一旦修正するのは保留としてます。

typos実行時の出力全体を以下に添付します。 out.txt

Joseph0304 commented 9 months ago

Actionsでtyposを使ったチェックをしてもよいのでは？とは思ったのですが、

など運用するうえでいくつか課題もありそうだと感じています。

faithandbrave commented 9 months ago

ありがとうございます。

規格内の変数名に一貫性がないこともあり、識別子は一旦、全部無視してもらえるといいですね。 規格の変数名に必ずしも従う必要もないのですが、修正指示にそのまま従ってしまうと以下のようなケースは関数名と変数名が被ってしまうので、がんばって修正案を考えるポイントでもないと思うこともあり、あまり手を入れたくないですね。

void param(const param_type& parm);

本サイトのMarkdownは拡張記法が入っていることもあり、ツールでの直接制御が難しい場合には、

  1. ツールの出力結果にフィルターをかけるツールを作る
  2. 別ツールを作る
  3. 一旦しばらくは自身のローカルチェックとして使うに留めておく

あたりの選択が考えられそうですね。

typoがあることで本サイトの価値が下がるものではないと思うので、ツール整備にそれほど労力をかけたくない気はしています。

Joseph0304 commented 9 months ago

@faithandbrave https://github.com/cpprefjp/site/pull/1226#issuecomment-1875304123 これに関しては「自身のローカルチェックとして使うに留めておく」でもよいかもしれませんね。 本PRで一旦typosで修正をかけたので、例えば次回は1年後にチェックをかけるなどすればよさそうです。

Joseph0304 commented 9 months ago

@akinomyoga 3fc04aa コメントありがとうございました。 こちらで修正しました。