Fix typos across the documentation

Kanato Konorequested to merge
chikasuiro/frontistr_documents:feature/fix-typos into main

Close #33 (closed)

概要

docs/ 配下の誤記を修正しました。94ファイル・181箇所（挿入181・削除181で行数の増減なし）。

正しい綴りの判定は FrontISTR 本体の実装を一次根拠としています。 推測で「それらしい綴り」に直した箇所はありません。

変更内容

誤記の分類ごとに10コミットに分けています。分類単位で採否を判断できます。

コミット 内容 箇所
Fix misspelled FrontISTR keyword names !MATERICAL→!MATERIAL、!ELEMNT→!ELEMENT、!BOUDARY→!BOUNDARY 7
Correct keyword spellings that the parser does not accept !CONTACT_PAIR→!CONTACT PAIR、!EMBED_PAIR→!EMBED PAIR、!TIME_POINT→!TIME_POINTS、!SUBITEM=k→SUBITEM=k 10
Fix misspelled parameter names and values DEFINTION、DRACKER-PRAGER、DEPETH、MATELIAL、POISSION、DISPLASEMENT、FUX1、CUPPER 17
Fix "Conditon" in the control file examples ### Boundary Conditon→### Boundary Condition 30
Fix English spelling in the keyword reference keyword_reference/ 配下 40
Fix the !VISUAL parameter name in the control file examples !VISUAL,metod=PSR→method=PSR 30
Fix English spelling in the functions reference and the guides functions_reference/・execution_guide/・coding_guide/ 10
Fix English spelling in the theory manual theory/ 10
Fix English spelling in the examples and the V&V section examples/・verification_and_validation/ 15
Sync the tutorial control file examples with the tutorial data tutorial_04・14・15 を実データに追従 12

判定根拠

対象 根拠
msh キーワード hecmw1/src/common/hecmw_heclex.l（字句規則の原本）
cnt キーワード fistr1/src/common/fstr_ctrl_*.f90 のキーワード文字列リテラル
!CONTACT PAIR / !EMBED PAIR hecmw_heclex.l:70-73 の ^!CONTACT" "?PAIR / ^!EMBED" "?PAIR。" "? は空白の省略可指定
DRUCKER-PRAGER fistr1/src/common/fstr_ctrl_material.f90:535 の許容値文字列
DEPTH hecmw1/tools/partitioner/hecmw_partlex.l:39
method（!VISUAL） hecmw1/src/visualizer/hecmw_vis_read_control.c:536
DISPLACEMENT 同 hecmw_vis_read_control.c:1300
uElastoPlasticNumStatus fistr1/src/lib/user/uyield.f90:24
制御ファイル例 FrontISTR/tutorial/*/*.cnt の現行データ

検出方法

以下を併用し、docs/ 全体を網羅的に走査しました。

  1. ! で始まるキーワードトークンを全件抽出し、FrontISTR ソースから機械抽出した正規キーワード集合との差集合を取る
  2. パラメータ名（NAME= の左辺）と値（右辺）を全件抽出し、FrontISTR ソース中の識別子集合と突合
  3. コードブロック・数式・リンクを除いた本文に aspell をかける
  4. コードブロック内容に aspell をかける
  5. 例題集の制御ファイル例と FrontISTR/tutorial/*/*.cnt を行単位で機械的に突合

手法5により、修正後は全チュートリアルで実データとの差分がゼロになっています。

検証

frontistr_documents には CI で走るテストがないため、リポジトリが提供する検証手段で確認しました。

検査 修正前 修正後
python3 tools/check_style.py 0 errors, 32 warnings 0 errors, 32 warnings
mkdocs build --clean exit 0、18 WARNING exit 0、18 WARNING

warning は diff で内容まで完全一致することを確認しており、本変更による増加はありません。 既存の warning はメタ情報コメント欠落・既存のリンク切れ等で、本変更とは無関係です。

見出しの変更は2箇所（keyword_reference/cnt/visualization/viewpoint.en.md の View coodinate frame、functions_reference/03_material.en.md の Nonelinear Static Analysis）ですが、 リポジトリ内から当該アンカーを参照している箇所はなく、ビルドの WARNING も増えていません。

方針

  • 修正は誤記の訂正に限定しています。文章の言い回し変更・章立ての変更・内容の加筆はありません
  • ja版・en版で同じ箇所に同じ誤記があるものは両方を揃えて修正しています
  • 表の修正では、語長の変化を前後の空白で吸収し、区切り | の桁位置を維持しています

レビューにあたってご判断いただきたい点

  1. !CONTACTPAIR / !EMBEDPAIR の表記 — 相互参照側を空白区切りの !CONTACT PAIR / !EMBED PAIR に統一しましたが、参照先の keyword_reference/msh/contactpair.{ja,en}.md / embedpair.{ja,en}.md は空白なしのままです。字句規則上どちらも受理されるため機能上の問題は ありませんが、リポジトリ内で2表記が併存します。統一する場合はページタイトル・見出しの変更を伴います
  2. CUPPER→COPPER — !MATERIAL, NAME= に与える材料名は利用者が任意に決める文字列であり、 CUPPER でも動作します。英単語としての誤りとして修正しましたが、意図的な命名であればお戻しください
  3. チュートリアルデータへの追従（最終コミット） — 単純な誤記ではなくマニュアルの staleness です。 別MRに分けたほうがよければ切り出します

既知の未対応

verification_and_validation/02_static.en.md:15 の Freedom frequency は、ja版の対応列が「自由度数」 であり本来 Number of degrees of freedom とすべき翻訳の誤りです。今回は誤記の訂正に範囲を限定した ため、綴り（freequency→frequency）のみ修正し語句はそのままにしています。

Merge request reports